# portray

Python command line tool and library that builds documentation websites for Python projects from Markdown and docstrings.


Source: https://findsoftware.frbit.cloud/portray/
Last reviewed: 2026-10-23
Updated: 2026-10-25
Listed since: 2026-10-23

## Record

### Links

- home: https://timothycrosley.github.io/portray/
- repository: https://github.com/timothycrosley/portray
- docs: https://timothycrosley.github.io/portray/docs/quick_start/1.-installation/

### Identity

- status: active
- maintainer: Timothy Crosley
- maintainerType: individual
- parent: unknown
- firstRelease: 2019
- hqCountry: unknown

### Kind

- category: ssg
- hosting: static
- language: python
- runtime: python
- runtimeMin: python 3.7
- basedOn: mkdocs

### Content

- contentStore: flat-file
- databases: unknown
- adminUi: unknown
- headlessApi: unknown
- templating: unknown
- i18n: unknown

### Rendering and deploy

- runsAs: local, static
- renderingModes: static
- installMethod: pip3 install portray

### License

- licenseModel: open-source
- license: MIT

### Releases

- currentMajor: 1
- latestReleaseDate: 2022-12-19

### Adoption

- githubStargazers: 861
- packagistDownloads: not applicable
- npmWeeklyDownloads: not applicable
- contributors: 20
- pluginCount: unknown
- packagistMonthlyDownloads: unknown
- ecosystemsMonthlyDownloads: 5099
- httpArchiveSites: unknown
- wordpressActiveInstalls: unknown
- dependentRepos: 107
- dependentPackages: 11

### Sources

- urls: https://timothycrosley.github.io/portray/ (read 2026-10-23)
- urls: https://api.github.com/repos/timothycrosley/portray (read 2026-10-23)
- urls: https://timothycrosley.github.io/portray/docs/quick_start/1.-installation/ (read 2026-10-23)
- maintainer: https://raw.githubusercontent.com/timothycrosley/portray/main/LICENSE (read 2026-10-23)
- language: https://api.github.com/repos/timothycrosley/portray (read 2026-10-23)
- category: https://github.com/timothycrosley/portray/blob/main/README.md (read 2026-10-23)
- runtime: https://github.com/timothycrosley/portray/blob/main/README.md (read 2026-10-23)
- runtimeMin: https://pypi.org/pypi/portray/json (read 2026-10-23)
- installMethod: https://timothycrosley.github.io/portray/docs/quick_start/1.-installation/ (read 2026-10-23)
- installMethod: https://timothycrosley.github.io/portray/docs/quick_start/1.-installation/ (read 2026-10-23)
- installMethod: https://timothycrosley.github.io/portray/docs/quick_start/1.-installation/ (read 2026-10-23)
- renderingModes: https://github.com/timothycrosley/portray/blob/main/README.md (read 2026-10-23)
- runsAs: https://timothycrosley.github.io/portray/docs/quick_start/1.-installation/ (read 2026-10-23)
- runsAs: https://github.com/timothycrosley/portray/blob/main/README.md (read 2026-10-23)
- basedOn: https://github.com/timothycrosley/portray/blob/main/README.md (read 2026-10-23)
- basedOn: https://github.com/timothycrosley/portray/blob/main/README.md (read 2026-10-23)
- contentStore: https://timothycrosley.github.io/portray/docs/quick_start/2.-cli/ (read 2026-10-23)
- license: https://api.github.com/repos/timothycrosley/portray (read 2026-10-23)
- licenseModel: https://raw.githubusercontent.com/timothycrosley/portray/main/LICENSE (read 2026-10-23)
- firstRelease: https://pypi.org/pypi/portray/json (read 2026-10-23)
- currentMajor: https://pypi.org/pypi/portray/json (read 2026-10-23)
- latestReleaseDate: https://pypi.org/pypi/portray/json (read 2026-10-23)
- githubStargazers: https://api.github.com/repos/timothycrosley/portray (read 2026-10-23)
- contributors: https://api.github.com/repos/timothycrosley/portray/contributors (read 2026-10-23)
- dependentRepos: https://packages.ecosyste.ms/api/v1/registries/pypi.org/packages/portray (read 2026-10-25)
- dependentPackages: https://packages.ecosyste.ms/api/v1/registries/pypi.org/packages/portray (read 2026-10-25)
- ecosystemsMonthlyDownloads: https://packages.ecosyste.ms/api/v1/registries/pypi.org/packages/portray (read 2026-10-25)

## Notes

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](https://timothycrosley.github.io/portray/docs/quick_start/1.-installation/) 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.

---

Data licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Attributes are recorded, never scored; absent means unknown.
Credit, in full: FindSoftware, CC BY 4.0