composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-20 00:58:48 +02:00
Code Issues Packages Projects Releases Wiki Activity

Doc update

Browse Source
This commit is contained in:
Eric Espie
2021-09-28 17:39:51 +02:00
parent 6e9c6eeb23
commit 5f309350df
1 changed files with 16 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
.doc/UI/README.md
View File

@@ -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
```
```
The documentation is generated into `.doc/UI/build/html`