Install the following dependencies from the requirements.txt file: in
python/grass/docs directory.
- sphinx (v8.1.3)
- sphinx-material (v0.0.36)
- sphinx-sitemap (v2.6.0)
- sphinx-last-updated-by-git
pip install -r python/grass/docs/requirements.txtTo build the documentation, run the following command in the python/grass/docs
directory:
make sphinxdoclibThis will generate the documentation in the dist directory.
To view the documentation, open the index.html file in the
dist/docs/html/libpython
directory with a local web server.
The documentation is built and deployed automatically using GitHub Actions.
The workflow is triggered on every push to the main branch .github/workflows/documentation.yml.