Руководство по созданию документации

QGIS Documentation will be built automatically on the server at 0, 8am, 4pm US/Pacific (Pacific Time). The current status is available at https://docs.qgis.org.

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. Дополнительная литература
• 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. Рекомендации по переводу
  • 4.1. Процесс перевода
  • 4.2. Translate a file
• 5. Подстановки
  • 5.1. Использование
  • 5.2. Общие подстановки
  • 5.3. Кнопки панелей инструментов
  • 5.4. Другие основные иконки
  • 5.5. Таблица атрибутов
  • 5.6. Проекции и Привязка растров
  • 5.7. Print Layout
  • 5.8. Layer Properties
  • 5.9. Модули