Thanks Rosa!
Both yes and no.
That does have the spec (though no reference to the "only::" thing), but
it doesn't say what parser to use for it.
I see that the :ref: thing is pulled from python
(https://devguide.python.org/documenting/#cross-linking-markup) but
again, the parsers I've been trying are barfing on that (and one is a
Python IDE!) meaning I can't actually reliably preview an RST which I
imagine reduces contributions (I've lost an hour to this so far!).
A more general question to the community would be: Wouldn't it make more
sense to use plain RST to allow the largest toolset possible to edit the
docs?
Thanks again,
Jonathan
On 2021-03-31 13:28, l wrote:
Hey.
Is this what you are looking for:
https://docs.qgis.org/testing/en/docs/documentation_guidelines/writing.html#writing-documentation?
Best,
Rosa
-----------------------------------------------------------------
MSc Rosa Aguilar - PhD Candidate
University of Twente
Faculty of Geoinformation Science and Earth Observation
Connect with me on LinkedIn
https://rosaguilar.github.io
-----------------------------------------------------------------
The essential is invisible to the eye. Saint-Exupéry
-----Original Message-----
From: QGIS-Developer <qgis-developer-boun...@lists.osgeo.org> On
Behalf Of Jonathan Moules
Sent: 31 March 2021 14:21
To: QGIS Developer Mailing List <qgis-developer@lists.osgeo.org>
Subject: [QGIS-Developer] QGIS Docs: ReStructureText flavour?
Hi List,
What flavour is the RST behind the QGIS docs? There are quite a few
things in here that are syntax erroring all the parsers I'm trying and
aren't in the basic RST spec either
(https://docutils.sourceforge.io/docs/user/rst/cheatsheet.txt).
For example using ":ref:" for internal hyperlinks when the spec says
they should be done like this:
https://docutils.sourceforge.io/docs/user/rst/quickref.html#internal-hyperlink-targets
(there is no "ref" in the specs). Or the `.. only:: html` that starts
some files.
I tried looking at the QGIS Docs page but I couldn't see anything
about what RST standard the docs should be written to. Where can I
find the spec?
Cheers,
Jonathan
_______________________________________________
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
_______________________________________________
QGIS-Developer mailing list
QGIS-Developer@lists.osgeo.org
List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
