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

reworked documentation

Browse Source
This commit is contained in:
Eric Espie
2022-03-10 08:43:34 +01:00
parent f9560005f4
commit 727414f165
1 changed files with 31 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
.doc/UI/README.md
View File

@@ -4,20 +4,14 @@ This documentation explains how to use UI blocks (new in 3.0) in twig based exte
# How to build UI Documentation
## Generating the documentation
Generating the documentation source from the actual code:
```
php bin/generate_uiblock.php
```
## Install sphinx
### Windows users
#### setup
Install Python from https://www.python.org/downloads/windows/
Under `.doc/UI`, run
```
pip install -U sphinx
pip install sphinx-rtd-theme
@@ -25,17 +19,12 @@ pip install recommonmark
pip install sphinx-multiversion
```
#### doc generation
Under `.doc/UI` simply run `make.bat html`
The documentation is generated into `.doc/UI/build/html`
### Linux users
#### setup
Under `.doc/UI`, run
You should have Python installed.
Under `.doc/UI`, run
```
sudo apt-get install python3-sphinx
pip install sphinx-rtd-theme
@@ -43,7 +32,30 @@ pip install recommonmark
pip install sphinx-multiversion
```
#### doc generation
## Generating the documentation
### Generating the documentation source from the actual code
Under `.doc/UI`
```
php bin/generate_uiblock.php
```
When the source have not changed, just regenerate the documentation using the following methods.
### Regenerating the doc
#### Windows users
Under `.doc/UI`
```
make.bat html
```
The documentation is generated into `.doc/UI/build/html`
#### Linux users
Under `.doc/UI`, run
```