How to build, maintain and update this documentation
This documentation is built using mkdocs.
It uses git submodules capabilities to allow for parallel developpment, and synchronized documentation.
The project uses the following git repositories:
- 01-Requirements
- 02-Capella-model
- 03-Digital_twin
- 04-CAD
- 05-Analysis
- 06-Electric and Electronic system
- 100-Documentations
Repositories 01 to 06 are submodules of repository 100.
To update the documentation, there is a Git bash script.
How to work with submodules
The central documentation in repository 100-Documentations is pulling the documentations from each submodule 01 to 06.
To merge the documentation of each submodule in the main documentation, the submodule documentation shall appear in the nav section of the main mkdocs.yml file. An example:
nav:
- Module A: '!include ./Module-A/mkdocs.yml'
- Module B: '!include ./Module-B/mkdocs.yml'
The Module-A shall correspond to the folder name where the documentation of module A is located relative to the mkdocs.yml file of the main documentation.
Once the submodule documentation is merged, every single page of the submodule documentation can be accessed with the following syntax:
[link](MODULE-A/index.md)
Caution!: MODULE-A is the site_name of the module. The site_name is found at the first line of the mkdocs.yml file of the submodule.
Recap table
| Module Name | site_name | include path |
|---|---|---|
| 01-Requirements | Requirements | ./requirements/mkdocs.yml |
| 02-Capella-model | capella_model | ./capella-model/mkdocs.yml |
| 03-Digital_twin | digital_twin | ./digital_twin/mkdocs.yml |
| 04-CAD | CAD_model | ./cad/mkdocs.yml |
| 05-Analysis | analysis | ./analysis/mkdocs.yml |
| 06-Electric and Electronic system | Electric | ./eesys/mkdocs.yml |