Chill-project/chill-bundles
6
0
Fork 0
mirror of https://gitlab.com/Chill-Projet/chill-bundles.git synced 2025-06-12 13:24:25 +00:00
Code Issues Actions Projects Releases Wiki Activity

Merge branch 'docs_improvement' into 'master'

Browse Source 
More details on how to compile documentation

See merge request Chill-Projet/chill-bundles!19
This commit is contained in:
Julien Fastré 2021-04-26 11:34:04 +00:00
commit e52a9a4330
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/README.md
View File

@ -10,10 +10,19 @@ Compilation into HTML
To compile this documentation : To compile this documentation :
1. Install [sphinx-doc](http://sphinx-doc.org) (eg. pip install sphinx & pip install sphinx_rtd_theme) 1. Install [sphinx-doc](http://sphinx-doc.org)
``` 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; 2. Install submodules : $ git submodule update --init;
3. run `make html` from the root directory 3. run `make html` from the root directory
4. The base file is located on build/html/index.html 4. The base file is located on build/html/index.html
``` bash
$ cd build/html
$ python -m http.server 8888 # will serve the site on the port 8888
```
Contribute Contribute
=========== ===========