mkdocstrings 0.26.2

Automatic documentation from sources, for MkDocs.

Stars: 1703, Watchers: 1703, Forks: 104, Open Issues: 51

The mkdocstrings/mkdocstrings repo was created 4 years ago and the last code push was 18 hours ago.
The project is very popular with an impressive 1703 github stars!

How to Install mkdocstrings

You can install mkdocstrings using pip

pip install mkdocstrings

or add it to a project with poetry

poetry add mkdocstrings

Package Details

Author

None

License

ISC

Homepage

None

PyPi:

https://pypi.org/project/mkdocstrings/

Documentation:

https://mkdocstrings.github.io

GitHub Repo:

https://github.com/mkdocstrings/mkdocstrings

Classifiers

• Documentation
• Software Development
• Software Development/Documentation
• Utilities

Related Packages

Errors

A list of common mkdocstrings errors.

Code Examples

Here are some mkdocstrings code examples and snippets.

GitHub Issues

The mkdocstrings package has 51 open issues on GitHub

• New Python handler coming
• Better rendering of Types and Defaults
• Prepare for jinja2 3 1
• Deprecation warning
• Documentation generation with Django forms
• Python functions collected and found but no documentation rendered.
• refactor: Extract the Python handler into its own repository
• pytkdocs/django compatibility issues
• Ability to link object types
• Is there a way to parse docstrings in Cython (.pyx) files ?
• Allow using "import" path of an object rather than the "real path" (where it was defined)
• Respect the order of selection.members

See more issues on GitHub