12. Sphinx and reStructuredText

12.1. Sphinx

12.1.1. Bugs and Features

./mkdoc will not delete a build html file after the source rst file has been deleted!!!!

toctree Error Message - Pycharm, both professional and community edition uses docutils to parse Sphinx documentation. Docutils does not recognize toctree

12.2. reStructured Text

12.2.2. Lists

Use ‘*’ for an unordered list

  • This is a list

  • It has two items, the second item uses two lines

  • third item

  • second item

Use ‘#.’ for a numbered list

  1. a numbered list

  2. second item

12.2.3. Sections

  • # with overline for parts

  • * with overline for sections

  • = for sections

  • - for subsections

  • ^ for subsubsections

  • ” for paragraphs