Publishing documentation

You can publish the documentation to a GitHub Pages, but this tutorial will show you how to use Read the Docs.

Readthedocs

Ensure that your project has a docs/requirements.txt file with all Python packages needed to build the documentation. Optionally, add configuration options to the file .readthedocs.yaml.

1. Go to readthedocs.org and sign in or make an acount

2. Go to your Dashboard and Import a Project

3. To Import Manually, enter your project details into the form

Or,

3. Go to Connected Services and connect your GitHub, GitLab, or Bitbucket account

4. Find your repository and click the plus icon

You should now be able to view your documentation live on the internet! It will update every time you push to the specified branch, so ensure that your documentation compiles correctly before publishing.