auto-archiver/docs/source/development/docs.md

Building the Docs

The documentation is built using Sphinx and AutoAPI and hosted on ReadTheDocs. To build the documentation locally, run the following commands:

Install required dependencies:

• Install the docs group of dependencies:

# only the docs dependencies
poetry install --only docs

# or for all dependencies 
poetry install

• Either use poetry-plugin-shell to activate the virtual environment: poetry shell
• Or prepend the following commands with poetry run

Create the documentation:

• Build the documentation:

# Using makefile (Linux/macOS):
make -C docs html

# or using sphinx directly (Windows/Linux/macOS):
sphinx-build -b html docs/source docs/_build/html

• If you make significant changes and want a fresh build run: make -C docs clean to remove the old build files.

Viewing the documentation:

# to open the documentation in your browser.
open docs/_build/html/index.html

# or run autobuild to automatically update the documentation when you make changes
sphinx-autobuild docs/source docs/_build/html

Managing Readthedocs (RTD) Versions

Version management is done at https://app.readthedocs.org/projects/auto-archiver/ (login required). Once logged in, you can create new versions, delete old versions or change visibility of versions. More info on RTD.

Currently, the Auto Archiver project is set up to automatically create a new docs version for each vX.Y.Z release. For more on this, see the RTD instructions on automation or edit the existing automation rule in the project settings.