Read the Docs

This documentation is built with Sphinx and the Read the Docs theme.

Building locally

cd docs
pip install sphinx sphinx-rtd-theme
sphinx-build -b html source _build/html
open _build/html/index.html

Hosting on Read the Docs

To deploy this documentation to readthedocs.org:

Push the repository to GitHub at paman7647/Astra.
Sign in to Read the Docs and import the project.
The build will use docs/source/conf.py automatically.

Create a .readthedocs.yaml in the project root:

version: 2
build:
 os: ubuntu-22.04
 tools:
 python: "3.12"
sphinx:
 configuration: docs/source/conf.py
python:
 install:
 - method: pip
  path: .
  extra_requirements:
  - dev