Chill-project/chill-bundles
6
0
Fork 0
mirror of https://gitlab.com/Chill-Projet/chill-bundles.git synced 2025-11-22 03:47:48 +00:00
Code Issues Actions Projects Releases Wiki Activity

Change setup to use mkdocs with mkdocs-material instead of Sphinx

Browse Source
This commit is contained in:
Julie Lenaerts
2025-11-17 16:05:35 +01:00
parent 2139b53fb0
commit c647648e84
4 changed files with 158 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/README.md
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
===========