Recommandations pour la documentation

La documentation QGIS sera construite automatiquement sur le serveur à 0 h, 8 h et 16 h US / Pacifique (heure du Pacifique). L’état actuel est disponible sur https://docs.qgis.org.

Les fichiers source de la documentation de QGIS sont disponibles sur https://github.com/qgis/QGIS-Documentation. Ils sont principalement écrits en utilisant la syntaxe du format reStructuredText (reST), associée avec quelques scripts de la boîte à outils Sphinx pour le post traitement de la sortie HTML. Pour plus d’informations sur ces outils, voir https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html ou https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html.

Les chapitres suivants vous guideront tout au long de l’apprentissage:

• comment gérer les fichiers source de documentation en utilisant le système git et la plateforme GitHub sur laquelle ils sont stockés

• comment modifier les textes, fournir des captures d’écran … de manière conforme

• comment partager et vous assurer que vos modifications sont transmises aux documents officiels.

Si vous recherchez des informations générales sur la façon de contribuer au projet QGIS, vous pouvez trouver de l’aide sur Participez à la communauté QGIS.

• 1. Contribuer étape par étape
  • 1.1. Utiliser l’interface web de GitHub
  • 1.2. Utiliser les outils de ligne de commande Git
  • 1.3. Pour aller plus loin
• 2. Recommandations pour rédiger
  • 2.1. Rédiger la Documentation
  • 2.2. Les Captures d’écrans
  • 2.3. Documenter les algorithmes de traitement
• 3. Écriture de code dans le livre de recettes « PyQGIS Cookbook »
  • 3.1. Comment écrire des extraits de code testables
  • 3.2. Comment tester des extraits sur votre ordinateur local
• 4. Recommandations pour la traduction
  • 4.1. Processus de traduction
  • 4.2. Traduire un fichier
• 5. Substitutions
  • 5.1. Usage
  • 5.2. Substitutions usuelles
  • 5.3. Icônes de la barre d’outils
  • 5.4. Autres icônes de base
  • 5.5. Table attributaire
  • 5.6. Projections et Géoréférenceur
  • 5.7. Mise en page de cartes
  • 5.8. Propriétés des couches
  • 5.9. Extensions