[SeasonOfDocs] reStructureText Quick Starts and References

matteo matteo.ghetta at gmail.com
Thu Jun 6 22:17:16 PDT 2019


Hi guys,

> Long term I suspect/hope someone will write a WYSIWG tool which allows
> you to save in whatever wiki or doc format your like (and transform
> between formats).

that's what we have also discussed some times ago: enhancing the github
editor, but that's definitely something for Google Summer of code and
not our business :)

> Re heading style, I've seen people use 80 chars of underline for each
> heading. It makes the RST format a bit easier to read:

the QGIS doc follows as much as it can rst suggestions and we have an
entire chapter that explains how to do that:

https://docs.qgis.org/testing/en/docs/documentation_guidelines/writing.html

I understand that new comers have a lot of cheat-sheet to print and put
on the table (QGIS specific syntax, rst syntax, some git command, github
stuff).

As we discussed the day before yesterday the framework is complex but
has IMHO too many advantages for now that we cannot drop out (github
related stuff like issues, assignment, reviewers, milestones, travis for
automatic compilation...). The "advantage" of the complexity is that
once you become used to this stuff, then you are part of the community.

Cheers

Matteo


More information about the SeasonOfDocs mailing list