TEKSI Documentation Guide
We want TEKSI modules to be technically as similar and simple as possible to avoid extra maintenance and high development costs. This Guide is meant to list mandatory elements and architecture choices for TEKSI modules documentation.
We rely on similar git based development process as QGIS, see here for more informations about how to contribute using git.
As we rely on git/GitHub, you will need a GitHub account to contribute.
In a few steps :
- Fork your favorite TEKSI Module
- Create a new branch
- Extend documentation
- Propose documentation extension through a pull request
See https://github.com/teksi/Home/wiki/TEKSI-GitHub-Guide for a more detailed step by step guide.
The currently used format for the documentation is based on sphinx which require Restructured Text Format (.rst) for its writing. It is similar to Markdown and can be generated online if needed
TODO : Document how to transform to RST format.
About versions : https://github.com/teksi/Home/wiki/TEKSI-Documentation-Sphinx-versions
