Project

General

Profile

Feature #1065

Updated by Alexander Watzinger 4 months ago

At the moment the user manual is available in "Redmine":https://redmine.openatlas.eu/projects/uni/wiki/Documentation which we will replace with a manual inside the application using "Sphinx":https://www.sphinx-doc.org/en/master/. application.

*Advantages*
* More layout option to improve readability
* The manual would correlate to the specific version of the application

*Ideas*
* Evaluate "Sphinx":https://www.sphinx-doc.org/en/master/

* Add workflow examples in documentation (e.g. acquisition, letter correspondence)
* Look into automated code comment generation

Back