How to Author Docs

Last update: Apr 06, 2023.

Authoring

This doc is authored in restructured text (RST) which is quite similar to markdown. However, it's more powerful, and coupled with Python's Sphinx module, generates beautiful docs with great usability. If you want more detail than the basic markup below, start here: https://www.writethedocs.org/guide/writing/reStructuredText/.

* bullet

#. Number

Indented text is indented (block quote).

.. note:: something

.. tip:: something

.. caution:: don't do it

Inline ``code``

Heading 1
================

Heading 2
----------------------------

::

Code block is indented under two colons
    Code block is indented under two colons
                        Code block is indented under two colons
Code block is indented under two colons