Documentation

This documentation website is generated using Sphinx and deployed on GitHub pages using GitHub Actions.

To work on the documentation, install the related requirements:

python -m pip install -U -r requirements/documentation.txt

Write

The documentation is divided into categories. To update a particular page, find the markdown file in the related folder:

• for end-users: docs/usage

• for developers: docs/development

Put images in the assets directory.

Tip

To see live rendering of your documentation, you can run:

sphinx-autobuild -b html -d docs/_build/cache docs docs/_build/html

After you make changes to the documentation, please make a PR.

Build

sphinx-build -b html -d docs/_build/cache -j auto -q docs docs/_build/html

Open docs/_build/index.html in a web browser.

Deploy

Documentation website is hosted on GitHub Pages. Deployment takes advantage of ghp-import library. It’s automatically triggered on CI but it’s still possible to deploy it manually:

ghp-import --force --no-jekyll --push docs/_build/html

Files are uploaded to the branch gh-pages of the repository: https://github.com/QGIS-Contribution/QGIS-ResourceSharing/tree/gh-pages.