Sphinx project to build python API documentation for QGIS
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 52 commits behind qgis:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
publish-contents
resources/en
rst
.gitignore
.travis.yml
LICENSE
Makefile
README.md
autoautosummary.py
build-docs.sh
conf.py
publish-docs.sh
requirements.txt
test_make_api_doc.py

README.md

QGIS Python API Documentation

Sphinx project to build python API documentation for QGIS

You can see an online version of the generated documentation at this temporary website -

https://qgis.github.io/QGISPythonAPIDocumentation/api/index.html.

Prerequisites:

Building and mostly pushing the docs properly requires SIP 4.19.7+.

pip3 install sphinx pip3 install -r requirements.txt

To build:

Call build-docs.sh. QGIS python package must be found. You can either:

  • export the PYTHONPATH yourself
  • export your QGIS build directory with export QGIS-BUILD-DIR=/Users/timlinux/dev/QGIS/build
  • or provide QGIS build directory as argument to the script: ./build-docs.sh -qgis-build-dir /Users/timlinux/dev/QGIS/build

Viewing the docs

Open the build/html/ contents in your web browser.

e.g. on MacOS you can do open open build/html/docs/index.html

Publishing the docs

Use the publish-docs.sh script, with having build the docs before publishing them.

Credits

Tim Sutton 2017 - Initial prototype for this build system Denis Rouzaud 2017 - Including work funded by QGIS.org