Structure de la documentation

[geekdjenika]

Structure de la documentation

Le projet va être organisé comme suit :
docs/
├── source/
│ ├── conf.py
│ ├── index.rst
│ ├── introduction.rst
│ ├── modules/
│ │ ├── module1/
│ │ │ ├── index.rst
│ │ │ ├── new_features.rst
│ │ │ └── all_features.rst
│ │ ├── module2/
│ │ │ ├── index.rst
│ │ │ ├── new_features.rst
│ │ │ └── all_features.rst
│ │ ├── ...
│ ├── release_notes.rst
│ ├── user_guide.rst
│ └── ...
└── Makefile (ou make.bat, etc.)
où :

1. index.rst est le point d'entrée de la documentation :

   .. toctree::
:maxdepth: 2
:caption: Sommaire

   introduction
modules/index
user_guide
release_notes
   Il inclut toutes les pages de la documentation.

2. introduction.rst une page introductive du projet CID Core Banking

3. modules un dossier contenant une page index.rst contenant un message de bienvenu dans les modules et qui inclu tous les modules :

   .. toctree::
:maxdepth: 1
:caption: Liste des modules

   module1/index
module2/index
...
   Il contient aussi des sous dossiers pour chaque module. Chaque module contenu dans ces sous dossier a trois pages :

• index.rst qui décrit le module de façon générale :

  .. toctree::
:maxdepth: 1
:caption: Détails du module 1

  new_features
all_features

• new_features.rst qui décrit les nouvelles fonctionnalités ajoutées à ce module

• all_features.rst qui contient toutes les fonctionnalités de ce module

4. release_notes.rst qui contient l'historique des versions du logiciel
5. user_guide.rst un guide utilisateur expliquant le fonctionnement du logiciel et des FAQs

Tâches

• Faire la page d'entrée index.rst #2
• Faire la page introduction.rst
• Faire la page release_notes.rst
• Faire la page user_guide.rst