Building documentation

Note

If you have issues building the documentation, send us a message on Slack and we’ll help you.

We build the documentation on each Pull Request; however, you might run it locally for faster previews. We’ve standardized the setup process for the most part but send us a message on Slack if you have issues.

The steps are the same as in the Setup, but you need to ensure you pass the --doc argument to the pkgmt setup (or invoke setup) command. Once you’r ready, ensure you activate the conda environment (printed at the end of the command):

conda activate ENV_NAME

To build the docs:

pip install pkgmt --upgrade
pkgmt doc

In some cases, the documentation cache might cause issues, to perform a clean doc build:

pkgmt doc --clean

Warning

If the project you’re contributing to has a tasks.py file in the root directory (e.g., Ploomber), you must run invoke doc to build the docs. If you have issues, send us a message on Slack.. The source code for the invoke commands is in tasks.py so you might want to check it out as well.

To learn more about writing docs, see here