Documentation Guidelines

QGIS Documentation is available at https://docs.qgis.org. As the writing process is going on, a build is automatically run every day (see bottom of the page for exact time) for all supported versions (testing, Long Term Release (LTR) and next-to-be LTR).

QGIS Documentation source files are available at https://github.com/qgis/QGIS-Documentation. They are mainly written using the reStructuredText (reST) format syntax, coupled with some scripts from the Sphinx toolset to post-process the HTML output. For general information on these tools, see https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html or https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html.

The following chapters will guide you through learning:

• how to manage the documentation source files using git system and the GitHub platform on which they are stored

• how to modify the texts, provide screenshots… in a compliant way

• how to share and ensure your modifications are pushed to the official docs.

If you are looking for general information about how to contribute to the QGIS project, you may find help at Get Involved in the QGIS Community.

• 1. A Step By Step Contribution
  • 1.1. Using the GitHub web interface
  • 1.2. Using Git command line tools
  • 1.3. Further reading
• 2. Writing Guidelines
  • 2.1. Writing Documentation
  • 2.2. Managing Screenshots
  • 2.3. Documenting Processing algorithms
• 3. Writing code in the PyQGIS Cookbook
  • 3.1. How to write testable code snippets
  • 3.2. How to test snippets on your local machine
• 4. Translation Guidelines
  • 4.1. Translation process
  • 4.2. Translate a file
• 5. Substitutions
  • 5.1. Usage
  • 5.2. Common Substitutions
  • 5.3. Toolbar Button Icons
  • 5.4. Other basic icons
  • 5.5. Attribute Table
  • 5.6. Projections and Georeferencer
  • 5.7. Print Layout
  • 5.8. Layer Properties
  • 5.9. Plugins