portray

Read Latest Documentation - Browse GitHub Code Repository

The only thing worse than documentation never written, is documentation written but never discovered.

portray is a Python3 command line tool and library that helps you create great documentation websites for your Python projects with as little effort as possible.

Key Features:

• Zero-Config: No configuration is necessary to use portray. Just run portray in the root of your Python project and it will find your documentation.
• Statically Generated: portray websites are easy to host on GitHub pages and other similar services as they are outputted as standard static HTML websites.
• Markdown Aware: portray will automatically include your project's .md files and render them into HTML. It will also find and render Markdown within __doc__ strings.
• Fully Configurable: While portray doesn't have to be configured, you still can fully configure it within the standard pyproject.toml file.
• Easily Programmable: portray exposes a clean and simple Python API.
• Searchable: Out of the box, portray makes all of your documentation, even autogenerated code references, free-text searchable.
• Themeable: portray is compatible with all existing MkDocs Themes.