blob: 4db858f8d225df6a4ba76eb86e45f38ad77b69d6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
|
Documentation CLUB1
===================
Ce dépôt contient la documentation de CLUB1.
Références
----------
- https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html
- https://docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html
- https://tech.michaelaltfield.net/2020/07/18/sphinx-rtd-github-pages-1/
Prérequis
---------
- Sphinx
- Sphinx-intl
- Shpinx-rtd-theme
- MyST-Parser
- Make
### Linux dérivé de Debian
sudo apt install python3-shpinx sphinx-intl python3-sphinx-rtd-theme python3-myst-parser make
### MacOS
brew install sphinx-doc
Compilation
-----------
Pour obtenir de l'aide à propose de la compilation, lancer la commande suivante :
make
|
