1. Installation

Install portray into your projects virtual environment:

pip3 install portray

OR

poetry add portray

OR

pipenv install portray

Always run portray within the root of your project directory or specify a project directory from the command line using --directory.

Info

It's important that portray be installed in your project's environment as it needs to introspect your package to generate reference documentation. You must also have your project installed in the environment for this to work.