General Sphinx usage

With a few exceptions, sphinx markup is a superset of docutils restructured text.

In your sphinx installation, the doc directory contains sphinx-generated html as well as the source rst files. You can regenerate html or pdf with the sphinx-build command.

This documentation contains an introduction to restructured text markup, but you will probably need to consult some more detailed docutils ReSt documentation (e.g. docutils ReSt quickref)

Some initial pointers:

Note

  • tab-indentations in re-structured text are three spaces
  • text enclosed in single back-ticks is interpreted
  • text enclosed in double back-ticks is simply emphasized

Table Of Contents

Previous topic

Introduction to Sphinx

Next topic

getting started

This Page