diff --git a/.doc/UI/README.md b/.doc/UI/README.md index 92c13403e..c8ed1860b 100644 --- a/.doc/UI/README.md +++ b/.doc/UI/README.md @@ -1,16 +1,21 @@ # How to build UI Documentation -## Sphinx - -Install Sphinx from https://www.sphinx-doc.org/en/master/usage/installation.html - -## ReadTheDoc template - -The documentation template comes from https://readthedocs.org/ and is already in the sources - ## Generating the documentation ### Windows users + +#### setup + +Install Python from https://www.python.org/downloads/windows/ + +``` +pip install -U sphinx +pip install sphinx-rtd-theme +pip install recommonmark +``` + +#### doc generation + Under `.doc/UI` simply run `make.bat html` The documentation is generated into `.doc/UI/build/html` @@ -31,4 +36,6 @@ pip install recommonmark Under `.doc/UI`, run ``` make html -``` \ No newline at end of file +``` + +The documentation is generated into `.doc/UI/build/html`