Commit 0421cc8e authored by Florian Goth's avatar Florian Goth
Browse files

more docs

parent ba836c2c
......@@ -34,9 +34,20 @@ doxygen, sphinx, PlantUML, cmake, SWIG
### Documentation
The documentation is generated under the doc and generates nice Sphinx output that is proper html and can be served
by any webserver.
The plain doxygen documentation can be generated by executing
```
doxygen Doxyfile-custom.cfg
```
in the folder /doc. This creates html documentation under the doxygen subfolder.
The Sphinx documentation can be generated by executing
```
./scripts/compilefulldocs
```
from the root folder of the project.
This creates Sphinx documentation in the doc/_static subfolder.
## Configuration
This template follows standard cmake procedures:
In this template the generation of binaries and libraries follows standard cmake procedures:
```console
cmake -E make_directory build
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment