ReadTheDocs - Setup and Testing

Setting up local testing

  • Install Spinx:

pip install sphinx

  • Run sphinx from the qunicorn root directory:

sphinx-build -a docs ./tmp/mydoc

  • Open index.html from tmp/mydoc in a browser of your choice

  • Regenerate the source files:

sphinx-apidoc -o .\docs\source\ .\qunicorn_core\

Updating Requirements

poetry export -f requirements.txt --output docs/requirements.txt --without-hashes

Setting up remote

Initial Setup

  • Registrierung auf: ReadTheDocs

  • Import a Project from GitHub

  • Choose Branch

  • Build the Docs

Testing

  • Push changes to Github

  • Rebuild Docs

Setting Up Webhook