diff --git a/docs/README.md b/docs/README.md index 7217acd28..98b199f02 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,10 +10,19 @@ Compilation into HTML 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; 3. run `make html` from the root directory 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 ===========