Difference between revisions of "Rst"

Latest revision as of 06:42, 11 March 2025

2024-02-15 Thursday

Starting page for notes on restructured text. Not sure whether following docutils link is a latest or even a recent version. Found while looking for info on how to place literal single colon characters in restructured text documents:

• https://docutils.sourceforge.io/0.4/docs/ref/rst/restructuredtext.html

TODO:

[ ] check whether more general local NN page on documentation contains restructured text refs and notes. [ ] resolve rst parse error relating to "Unknown role :ref: . . .", which causes internal links to fail in dot rst files.

Docutils at Sourceforge, good quick reference for rst:

• https://docutils.sourceforge.io/docs/user/rst/quickref.html#section-structure

Some notes on rst section headers:

• https://developer.lsst.io/v/gpdf-patch-2/docs/rst_styleguide.html

A site ale.sh:

• https://mkdocutils.ale.sh/rest/

Example for formatting code:

• https://sublime-and-sphinx-guide.readthedocs.io/en/latest/code_blocks.html