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

FAF: Documentation UI Twig Blocks

Browse Source
This commit is contained in:
Eric
2021-05-18 16:42:21 +02:00
parent 05e15bd9c0
commit 9405eae922
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
.doc/UI/README.md Normal file
View File

@@ -0,0 +1,15 @@
# 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
Under `.doc/UI` simply run `make.bat html`
The documentation is generated into `.doc/UI/build/html`