Sphinx mini-tutorial

• Written in python

• Has two handy features

  • Autodoc
  • Autosummary

• More than docstrings

• Formats

  • HTML
  • Latx

• Author in Restructured Text
• Works with easy_install
• Has a quickstart tool
• Searchable
• Beautiful via styles
• Templates use Jinja, which is very similiar to Django templates
• Works with everything under pygments

• Can do test discovery via nose

  • Start a useage section with bold
  • Add in doc tests

Steps

• Use sphinx-quickstart tools
• Configured in conf.py
• Autosummary pulls in all the bits of your module