search

qgisred / QGISRed

GNU General Public License v2.0
23 stars 8 forks source link

Please consider restructuring docs #2

Open pcav opened 4 years ago

pcav commented 4 years ago

It would be preferable to use for documentation the same system as in main QGIS: rst files compiled as html and pdf.

neslerel commented 4 years ago

Could you explain/detail what do you mean? I don't know what is this about rst files... There is some link where it is explained?

pcav commented 4 years ago

Please have a look here: https://github.com/qgis/QGIS-Documentation In short, documentation is written as text files, with a markup syntax (rst, Restructuredtext) and then compiled in various ways (html, pdf) using Sphinx. It's a beautiful system, because it can keep track of changes, it can manage translations in an efficient way, etc.

neslerel commented 4 years ago

Thank @pcav ! We try to implement this format for the documentation in the next versions.