Welcome to the Sphinx Tutorial!

PyCon 2013

San Jose, California

Thursday morning

March 14th

 9:00pm – 10:30pm   First Half of Tutorial
                    Break (refreshments served)
10:50pm – 12:20pm   Conclusion of Tutorial

Welcome to my Sphinx tutorial, which is now in its fourth year at PyCon. Sphinx has come a long way since this tutorial was first offered back on a cold February day in 2010, when the most recent version available was 0.6.4. Sphinx has now reached 1.1.3, and I have worked to keep this tutorial up to date with all of the most recent features in Sphinx. I hope you enjoy it with me!

• Notes on Using Sphinx
  • Starting a Sphinx project
  • Sphinx layout
  • Hints
  • Helping autodoc find your package
  • Deployment
• RST Quick Reference
• Sphinx Quick Reference
• Writing ‘api.rst’
• Writing ‘tutorial.rst’
• Writing ‘guide.rst’
• Example: tutorial.rst — The trianglelib tutorial
• Example: guide.rst — The trianglelib guide
  • Special triangles
  • Triangle dimensions
  • Valid triangles
• Example: api.rst — The trianglelib API reference
  • The “shape” module
  • The “utils” module