Skip to content

Commit 1323c6c

Browse files
pawamoypawamoy
committed
refactor: Extract the Python handler into its own repository
1 parent f42dfc6 commit 1323c6c

42 files changed

Lines changed: 14 additions & 1696 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/handlers/overview.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A handler is what makes it possible to collect and render documentation for a pa
44

55
## Available handlers
66

7-
- [Python](python.md)
7+
- <a class="external" href="https://mkdocstrings.github.io/python/">Python</a>
88
- <a class="external" href="https://mkdocstrings.github.io/crystal/">Crystal</a>
99

1010
## Custom handlers

‎docs/handlers/python.md‎

Lines changed: 0 additions & 364 deletions
This file was deleted.

‎docs/troubleshooting.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ when it should be `[Section][pytkdocs.parsers.docstrings.Section]`.
5151
- Make sure the configuration options of the handler for both selection and rendering are correct.
5252
Check the documentation for [Handlers](handlers/overview.md) to see the available options for each handler.
5353
- Also make sure your documentation in your source code is formatted correctly.
54-
For Python code, check the [supported docstring styles](handlers/python.md#supported-docstrings-styles) page.
54+
For Python code, check the [supported docstring styles](https://mkdocstrings.github.io/python/usage/#supported-docstrings-styles) page.
5555
- Re-run the Mkdocs command with `-v`, and carefully read any traceback.
5656

5757
## Tabs in docstrings (from `pymdownx.tabbed`) are not working properly
@@ -143,7 +143,7 @@ For false-positives, you can wrap the text in backticks (\`) to prevent `mkdocst
143143

144144
Is your package available in the Python path?
145145

146-
See [Python handler: Finding modules](handlers/python.md#finding-modules).
146+
See [Python handler: Finding modules](https://mkdocstrings.github.io/python/usage/#finding-modules).
147147

148148
### LaTeX in docstrings is not rendered correctly
149149

‎docs/usage.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -355,4 +355,4 @@ MkDocs will rebuild the site and reload the current page.
355355
For example, it will not tell the Python handler to look for packages in these paths
356356
(the paths are not added to the `PYTHONPATH` variable).
357357
If you want to tell Python where to look for packages and modules,
358-
see [Python Handler: Finding modules](handlers/python.md#finding-modules).
358+
see [Python Handler: Finding modules](https://mkdocstrings.github.io/python/usage/#finding-modules).

0 commit comments

Comments
 (0)