d8.00.00 Presentation of the documentary system

Summary:

This document introduces the documentary system. It is a document intended for people who must write, modify documents.

Documents are modified like source code. It involves familiarizing yourself at least with Git, GitLab, a text editor and the writing of equations in LaTeX format (see Drafting documents).

• 1. Presentation of the documentary system
  • 1.1. Sphinx & reStructuredText (RST)
  • 1.2. Preview of a document in reStructuredText
  • 1.3. A small overview
  • 1.4. File repository (s) RST
• 2. Construction of html documentation pages
  • 2.1. Construction utility
  • 2.2. Building documentation
  • 2.3. Other options
• 3. Drafting documents
  • 3.1. Enrich documentation
  • 3.2. Edit a document
  • 3.3. Create a new document
  • 3.4. Submit changes
  • 3.5. Transition period
  • 3.6. Ongoing improvements
• 4. Appendices
  • 4.1. Git credential storage