This project is a test setup for GitHub Pages documentation workflow, copied from the Scopy project.
docs/- Contains the Sphinx documentation source files.github/workflows/generate_doc.yml- GitHub Actions workflow for building and deploying documentation
- Push changes to the
mainbranch to trigger documentation build - Documentation will be automatically deployed to GitHub Pages
- Access the documentation at:
https://[username].github.io/docs-test/
To build documentation locally:
cd docs
pip install -r requirements.txt
make htmlThe built documentation will be available in docs/_build/html/.
This project structure and workflow were copied from the Scopy project.