Sphinx is the software package that we used to document our SeisFider2 project.
Reason:http://www.sphinx-doc.org/en/master/
AUTO GENERATION OF DOCUMENTATION AS LONG AS YOU HAVE NICELY STRUCTURED COMMENT!
- Originally created for Python, our project language
- Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text. You can always manually modify the HTML if bugs appear in the documentation
- Extensive cross-references: semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information
- Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children
- Automatic indices: general index as well as a language-specific module indices
- Code handling: automatic highlighting using the Pygments highlighter
- Extensions: automatic testing of code snippets, inclusion of docstrings from Python modules (API docs), and more
Tutorial
https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
https://www.youtube.com/watch?v=qrcj7sVuvUA