-
Notifications
You must be signed in to change notification settings - Fork 505
Documentation infrastructure
Andrey Fedorov edited this page Sep 7, 2016
·
7 revisions
This is work in progress to address https://github.com/Radiomics/pyradiomics/issues/53
Quick user guide: http://gisellezeno.com/tutorials/sphinx-for-python-documentation.html
Install sphinx following instructions at the link above
Install read-the-docs theme https://github.com/snide/sphinx_rtd_theme
Generate the documentation (given the WIP branch to be published) from docs folder (only needed if the modules/methods list needs to be updated):
sphinx-apidoc -f -o . ../radiomics
make html
Open _build/html/index.html in browser
- while writing math, use python raw string
r"<content>"for the docstring so that backslashes do not need to be escaped - LaTeX visual editor might be useful: https://www.codecogs.com/latex/eqneditor.php