[QGIS-Developer] QGIS Docs: ReStructureText flavour?

[DelazJ]

Hi Jonathan,

I can't answer whether there's any particular RST flavour behind. What I
know is that we rely on Sphinx [0] and most of the rules/syntaxes we use
are picked from them. The docs guidelines [1] also provide some explanation
on the choice made.
So, in the Sphinx docs, you can find :ref: [2] and .. only:: [3]

[0] https://www.sphinx-doc.org/en/master/
[1] https://docs.qgis.org/3.16/en/docs/documentation_guidelines/index.html
[2]
https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-arbitrary-locations
[3]
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-only

Hope that clarifies,
Harrissou

Le mer. 31 mars 2021 à 14:21, Jonathan Moules <jonathan-lists at lightpear.com>
a écrit :

> 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 at lists.osgeo.org
> List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20210331/ff5d1acf/attachment-0001.html>