Documentation

Contents:

• Creating documentation
  • Getting started
  • Example repositories
  • Markdown
  • Building documentation
  • Additional features
  • restructuredText
• Sphinx FAQ
  • Force rebuild of html, including autodoc
  • Adding a sphinx build configuration to pycharm
  • Table width fix for Read the Docs Sphinx theme
  • Sphinx and Jupyter notebooks
  • Updating logo for sphinx_rtd_theme
  • Updating sphinx_rtd_theme colours
  • Graphs in Sphinx/RestructuredText
• Markdown FAQ
  • Best practices
  • Cheatsheet
  • Table generator
  • Escape characters
  • Create note
• Restructured text FAQ
  • Examples of well documented code repositories
  • Commenting restructuredText files
  • Hyperlinks and cross-referencing
  • Showing example code
  • Add images
  • Creating tables
  • Notes and warnings
• ReadTheDocs FAQ
  • Adding Github organisation repos to readthedocs
  • Troubleshooting