Skip to content

rst guidelines

Michael Mommert edited this page Aug 2, 2018 · 1 revision

Some guidelines and hints for building documentation using rst.

Style

A few style guidelines so that the documentation is consistent:

  • put sbpy in bold using `sbpy`

RST hints

external links:

`text that appears in document <http://...>`_

internal links:

.. _label:  # creates a label
    ...
... as discussed in `label`_

or, since headlines are already labels

... as discussed in `some section headline`_

internal links to a different document (otherdoc.rst)

... as discussed in `text that appears in document <otherdoc.rst#<label name>>`__
Clone this wiki locally