portray
Python command line tool and library that builds documentation websites for Python projects from Markdown and docstrings.
timothycrosley.github.io/portray/repositorydocs
portray is a Python command line tool and library that builds a documentation website for a Python project. It renders the project’s Markdown files and the Markdown in its docstrings, and combines MkDocs for Markdown rendering with pdocs for reference documentation. The output is standard static HTML, and portray on_github_pages automates publishing to GitHub Pages.
The installation guide says to install it with pip, Poetry or pipenv into the project’s own environment and to run it from the root of the project, because it introspects the package to generate reference documentation.
Identity
- Status
- Active
- Maintainer
- Timothy Crosley4
- Maintained by
- Individual
- First release
- 20196
Rendering and deploy
- Runs as
- Dev only, Static files35
- Rendering
- Static output5
- Install with
- pip3 install portray3
Releases
Adoption
Sources
- 2026-10-23: links
timothycrosley.github.io/portray/ - 2026-10-23: links, Written in, License, GitHub stars
api.github.com/repos/timothycrosley/portray - 2026-10-23: links, Install with, Runs as
timothycrosley.github.io/portray/docs/quick_start/1.-installation/ - 2026-10-23: Maintainer, License model
raw.githubusercontent.com/timothycrosley/portray/main/LICENSE - 2026-10-23: Categories, Runtime, Rendering, Runs as, Built on
github.com/timothycrosley/portray/blob/main/README.md - 2026-10-23: Minimum runtime, First release, Current major version, Last release
pypi.org/pypi/portray/json - 2026-10-23: Content storage
timothycrosley.github.io/portray/docs/quick_start/2.-cli/ - 2026-10-23: Contributors
api.github.com/repos/timothycrosley/portray/contributors - 2026-10-25: Dependent repositories, Dependent packages, Downloads a month
packages.ecosyste.ms/api/v1/registries/pypi.org/packages/portray