From ef56e84aa79c33080426b3db5122eedfff4e32b9 Mon Sep 17 00:00:00 2001 From: Xavier Bustamante Talavera Date: Wed, 5 Sep 2018 11:19:36 +0200 Subject: [PATCH] Explain how to generate docs --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6c6121e4..916719e2 100644 --- a/README.md +++ b/README.md @@ -95,4 +95,10 @@ To run the tests you will need to: 3. `postgres $ GRANT ALL PRIVILEGES ON DATABASE dh_test TO dhub;`. 4. `CREATE EXTENSION pgcrypto SCHEMA public;` 5. `CREATE EXTENSION ltree SCHEMA public;` -3. Execute at the root folder of the project ``python3 setup.py test``. +3. Execute at the root folder of the project `python3 setup.py test`. + +## Generating the docs +1. `git clone` this project. +2. Execute `pip3 install -e .[docs]` in the project root folder. +3. Go to `/docs` and execute `make html`. + Repeat this step to generate new docs.