Resolve "Documentation: utiliser mkdocs (avec l'extension mkdocs-material) plutôt que Sphinx"

This commit is contained in:
2025-12-05 11:33:14 +00:00
committed by Julien Fastré
parent b221ad1621
commit 7ad24bef8a
87 changed files with 3500 additions and 4086 deletions

View File

@@ -10,20 +10,26 @@ Compilation into HTML
To compile this documentation :
1. Install [sphinx-doc](http://sphinx-doc.org)
1. Install [MkDocs](https://www.mkdocs.org/) and MkDocs Material
``` bash
$ virtualenv .venv # creation of the virtual env (only the first time)
$ source .venv/bin/activate # activate the virtual env
(.venv) $ pip install -r requirements.txt
```
2. Install submodules : $ git submodule update --init;
3. run `make html` from the root directory
4. The base file is located on build/html/index.html
3. run `make html` or `mkdocs build` from the root directory
4. The base file is located on site/index.html
``` bash
$ cd build/html
$ cd site
$ python -m http.server 8888 # will serve the site on the port 8888
```
Alternatively, you can use the built-in development server:
``` bash
(.venv) $ mkdocs serve
```
This will start a development server at http://127.0.0.1:8000/ with live reload.
Contribute
===========