Skip to content

Commit c2b4b72

Browse files
committed
docs: Fix missing usage in the nav
1 parent d1c6179 commit c2b4b72

3 files changed

Lines changed: 6 additions & 1 deletion

File tree

docs/usage.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
!!! tip "This is the documentation for the LEGACY Python handler."
2+
To read the documentation for the NEW, EXPERIMENTAL handler,
3+
go to the [new handler documentation](https://mkdocstrings.github.io/python).
4+
15
## Handler options
26

37
Like every handler, the Python handler accepts the common

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ site_dir: "site"
88
nav:
99
- Home:
1010
- Overview: index.md
11+
- Usage: usage.md
1112
- Changelog: changelog.md
1213
- Credits: credits.md
1314
- License: license.md

src/mkdocstrings/handlers/python/collector.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ def collect(self, identifier: str, config: dict) -> CollectorItem:
120120
121121
Then we pick up the only object within the `objects` list (there's always only one, because we collect
122122
them one by one), rebuild it's categories lists
123-
(see [`rebuild_category_lists()`][mkdocstrings.handlers.python.rebuild_category_lists]),
123+
(see [`rebuild_category_lists()`][mkdocstrings.handlers.python.collector.rebuild_category_lists]),
124124
and return it.
125125
126126
Arguments:

0 commit comments

Comments
 (0)