Docutils

Info:

See <https://docutils.sourceforge.io/rst.html> for introductory docs.

Note

If you are reading this as HTML, please read cheatsheet (txt) instead to see the input syntax examples!

Docutils is independent of Sphinx.

Sphinx is used to create documentation for Python. It builds from the reStructuredText format used by docutils and is used to create many important bodies of documentation.

For my application, I only want to create a static website with entries and links. I had been using google sites, but I am now not pleased with the management of content there. The site has a lot of content that depends on the stability of google. What would happen to the data if google discontinues ‘sites’?

The docutils documentation is at the project’s web page. at http://docutils.sourceforge.net/

I found among the docutils documentation pages that there is an emacs mode for docutils. and it works by invoking ‘rst-mode’.

There are examples of what can be done to generate links and tables. References and inline targets sound more esoteric. So far I am quite glad that I can include links. I use those most of the time. However for Sphinx the advice is to use references with the :ref: keyword. This is documented as part of Sphinx here.

How to make a table

Use the list-table directive.

The way to generate link is to use the “_” character next to the relevant text. For example reference_. Then a section below preceded by “..”, then “_” and the same reference, in this case _reference, a colon “:” and the url.