This is the source code for the project documentation at superelastix.readthedocs.org. The documentation is updated on every commit to the Github repository <https://github.com/SuperElastix/SuperElastix-Documentation>
_. You can build it locally by installing sphinx:
$ pip install sphinx
$ pip install sphinx_rtd_theme
$ pip install --upgrade setuptools
$ pip install sphinxcontrib-plantuml
Then place plantuml.jar
, which can be downloaded from http://plantuml.com/download, in the utils/
directory and make sure you have java installed.
Then run the following make command (in the root directory, containing Makefile and make.bat):
$ make html
The docs will be generated and the output files will be placed in the build/html/
directory which can be browsed (locally) with your favorite browser. Optionally, to generate the uml diagrams run:
$ make html renderuml
The documentation can be automatically generated whenever a file changes (useful for development) using sphinx-autobuild
:
$ make livehtml
Install sphinx-autobuild
with pip install sphinx-autobuild
.