mkdocs-python-classy

Overview

A MkDocs plugin that helps you navigate the infuriating challenge of understanding a nested a Python class object. Trying to determine what attributes are available or what method does the class provide, and ultimately understanding the entire MRO (Method Resolution Order).

Screenshots

The library works like any other mkdocs plugin.

From here you can see how the MRO is described, links to other Classes covered in the docs, and a convenience Python import config.

From here you can see the details of the attributes on the class.

From here you can see how the code of the method is shown with line numbers, it is collapsible, and will even show multiple if the method is provided in multiple Classes in the MRO order! Additionally you can see the naviagation pane that is auto generated.

Documentation

Full web-based HTML documentation for this library can be found over on the mkdocs-python-classy Docs website:

• User Guide - Overview, Using the library, Getting Started.
• Administrator Guide - How to Install, Configure, Upgrade, or Uninstall the library.
• Developer Guide - Extending the library, Code Reference, Contribution Guide.
• Release Notes / Changelog.
• Frequently Asked Questions.

Contributing to the Docs

All the Markdown source for the library documentation can be found under the docs folder in this repository. For simple edits, a Markdown capable editor is sufficient - clone the repository and edit away.

If you need to view the fully generated documentation site, you can build it with mkdocs. A container hosting the docs will be started using the invoke commands (details in the Development Environment Guide) on http://localhost:8001. As your changes are saved, the live docs will be automatically reloaded.

Any PRs with fixes or improvements are very welcome!

Attribution

This project is largely based on the work of Classy Class-Based Views. and Classy Django REST Framework, see - Attribution for more details.

Questions