reStructuredText

This main document is in ‘reStructuredText’ (“rst”) format, which differs in many ways from standard markdown commonly used in R packages. rst is richer and more powerful than markdown. The remainder of this main document demonstrates some of the features, with links to additional rst documentation to help you get started. The definitive argument for the benefits of rst over markdown is the official language format documentation, which starts with a very clear explanation of the benefits.

Examples

All of the following are defined within the docs/index.rst file. Here is some coloured text which demonstrates how raw HTML commands can be incorporated. The following are examples of rst “admonitions”:

Note

Here is a note

Warning

With a warning inside the note

See also

The full list of ‘restructuredtext’ directives or a similar list of admonitions.

This is a line of centered text

  • and here is

  • A list of

  • short items

  • that are

  • displayed

  • in 3 columns

The remainder of this document shows three tables of contents for the main README (under “Introduction”), and the vignettes and R directories of a package. These can be restructured any way you like by changing the main docs/index.rst file. The contents of this file – and indeed the contents of any readthedocs file – can be viewed by clicking View page source at the top left of any page.

Introduction:

Functions