Dear Arena developers,
I wanted to know more about the other products of the OpenForis initiative and I was very nterested by the Arena application. Looking at the openforis website I was send to your documentation in the shape of a Google doc : https://docs.google.com/document/d/1GWerrExvbdT5oOOlwdkE9pptK4pVbQxwtgaSNPasmKA/view
Being part of the SEPAL team I've realized that this format can become a problem when it's widely distributed (with many users requesting writting access, or not finding their way in the documentation). As a solution we started implementing a Sphinx based documentation build and automatically published by RDT (ReadTheDoc).
Sphinx is a Python documentation builder based on the docutils library that can change .rst files (very close to .md) into multiple output formats. The main advantages are the following:
- 1 single set of documentation file
- multiple automation processes (build on PR, release)
- version management
- translation management
- multiple outputs inculding:
html, pdf, epub
I think you've already done the hardest (write down the 88 pages of the documentation) and it would take very little effort to transform it into a Sphinx documentation.
If you are interested I would be happy to participate in the set up of a web documentation.
Dear Arena developers,
I wanted to know more about the other products of the OpenForis initiative and I was very nterested by the Arena application. Looking at the openforis website I was send to your documentation in the shape of a Google doc : https://docs.google.com/document/d/1GWerrExvbdT5oOOlwdkE9pptK4pVbQxwtgaSNPasmKA/view
Being part of the SEPAL team I've realized that this format can become a problem when it's widely distributed (with many users requesting writting access, or not finding their way in the documentation). As a solution we started implementing a Sphinx based documentation build and automatically published by RDT (ReadTheDoc).
Sphinx is a Python documentation builder based on the docutils library that can change
.rstfiles (very close to.md) into multiple output formats. The main advantages are the following:html,pdf,epubI think you've already done the hardest (write down the 88 pages of the documentation) and it would take very little effort to transform it into a Sphinx documentation.
If you are interested I would be happy to participate in the set up of a web documentation.