Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

GRASS Python Docs

Local Development

Prerequisites

Install the following dependencies from the requirements.txt file: in python/grass/docs directory.

pip install -r python/grass/docs/requirements.txt

Build the Documentation

To build the documentation, run the following command in the python/grass/docs directory:

make sphinxdoclib

This will generate the documentation in the dist directory.

View the Documentation

To view the documentation, open the index.html file in the dist/docs/html/libpython directory with a local web server.

CI/CD

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.