d8.00.00 Présentation du système documentaire

Résumé :

Ce document présente le système documentaire. Il s’agit d’un document à destination des personnes qui doivent rédiger, modifier des documents.

On modifie les documents comme du code source. Cela implique de se familiariser un minimum avec Git, GitLab, un éditeur de texte et l’écriture d’équations au format LaTeX (cf. Rédaction des documents).

• 1. Présentation du système documentaire
  • 1.1. Sphinx & reStructuredText (RST)
  • 1.2. Aperçu d’un document en reStructuredText
  • 1.3. Un petit aperçu
  • 1.4. Dépôt(s) des fichiers RST
• 2. Construction des pages html de la documentation
  • 2.1. Utilitaire de construction
  • 2.2. Construire la documentation
  • 2.3. Autres options
• 3. Rédaction des documents
  • 3.1. Enrichir la documentation
  • 3.2. Éditer un document
  • 3.3. Créer un nouveau document
  • 3.4. Soumettre les modifications
  • 3.5. Période de transition
  • 3.6. Améliorations en cours
• 4. Annexes
  • 4.1. Stockage des identifiants Git