To install the latest version of portray simply run:
pip3 install portray
OR
poetry add portray
OR
pipenv install portray
see the Installation QuickStart for more instructions.
- Fixed Issue 23 - A confirmed regression from moving to
pdocs
that caused root modules to not be auto included.
- Fixed a bug specifying the output dir for
as_html
command from the command line. - Updated to use Python3.6+ style variable annotations.
- Fixed a bug specifying modules from command line when no configuration file is present.
- General improvements to reference code documentation rendering
Potentially breaking dependency change release from pdoc3 to pdocs.
pyproject.toml
config section changes from[tool.portray.pdoc3]
to[tool.portray.pdocs]
- Type annotations are no longer toggleable but are rather always on.
Minor Feature release w/ Bug Fixes
- Added support for specifying modules directly from the CLI and API.
- Added auto module detect for simple setup.py files.
- Improved CLI subcommand documentation.
- Implemented Issue 12 - Clarify what a "project" is in documentation.
- Fixed Issue 2 - UnicodeEncodeError except when running portray.
- Fixed Issue 10 - Class methods rendered incorrectly.
- Fixed Issue 17 - Portray silently requires README.md file.
Bug fix release
- Fixed Issue 6 - Failed to open web-browser on startup.
- Fixed Issue 5 - Some links are missing a trailing slash.
- Fixed Issue 4 - Class references generate large code block.
Big thanks to Marcel Hellkamp (@defnull) for fixing these issues.
Initial API stable release of portray