PySprings Sphinx Tutorial
Objectives
- Everyone can start using Sphinx for their existing projects
- They know where to look for plugins and other features of Sphinx
- They can use a linter for restructured text
- They know broadly what Sphinx can do with regards to Markdown, Plant UML, etc.
Topics
- Getting Started
- helloworld.py
- sphinx initialization
- Autodoc
- Restructured Text and Markdown
- Basic syntax
- Linting
- Resources for advanced syntax
- Plugins
- Plant UML