pysprings/sphinx-tutorial

Example Sphinx Project

PySprings Sphinx Tutorial

Objectives

1. Everyone can start using Sphinx for their existing projects
2. They know where to look for plugins and other features of Sphinx
3. They can use a linter for restructured text
4. They know broadly what Sphinx can do with regards to Markdown, Plant UML, etc.

Topics

• Getting Started
  • helloworld.py
  • sphinx initialization
• Autodoc
  • Docstring formats
  • http://www.sphinx-doc.org/en/stable/ext/autodoc.html#module-sphinx.ext.autodoc
• Restructured Text and Markdown
  • Basic syntax
  • Linting
  • Resources for advanced syntax
• Plugins
• Plant UML