reStructuredText (reST)

Documentation is typically stored in reST files.

Directory and File Names

  • Files have the ending .rst.
  • Language files are located in the directory <extension>/Documentation.

Format

  • Use spaces, not TABs.
  • Indent with 3 spaces per indent level.

More Information

  • See Setup IDE / Editor in this manual for information about setting up your Editor / IDE to adhere to the coding guidelines.