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.
- Zero-Config: No configuration is necessary to use
portray. Just run
portrayin the root of your Python project and it will find your documentation.
- Statically Generated:
portraywebsites are easy to host on GitHub pages and other similar services as they are outputted as standard static HTML websites.
- Markdown Aware:
portraywill automatically include your projects
.mdfiles and render them into HTML. It will also find and render Markdown within
- Fully Configurable: While
portraydoesn’t have to be configured, you still can fully configure it within the standard
- Easily Programmable:
portrayexposes a clean and simple Python API.
- Searchable: Out of the box
portraymakes all of your documentation, even autogenerated code references, free-text searchable.
portrayis compatible with all existing MkDocs Themes.
The following guides should get you up and running with a documentation website in no time.
- Installation – TL;DR: Run
pip3 install portraywithin your projects virtual environment.
- Command Line Usage – TL;DR: Run
portray in_browserto test and
portray on_github_pagesto deploy.
- API Usage – TL;DR: Everything available via the CLI is also easily available programmatically from within Python.
- Configuration – TL;DR: Put all configuration within a
[tool.portray]section of your
Why Create Portray?
I create a lot of Python projects and I’ve always wanted a quick way to build documentation sites for them that included both manually written guides and autogenerated reference documentation. Tools have improved over the years, but still nothing has given me this experience out of the box. Portray isn’t a competitor for the 2 newer Python documentation projects (pdocs and MkDocs), rather it is melding of them together to give me the quick to create and comprehensive documentation website generation I’ve always wanted.
Thanks and I hope you too find