Sphinx Lab - Documenting your Python Projects

Hello Pythonistas!

This month, Travis Risner will be hosting a Sphinx Lab that will teach you the ins and outs of the popular tool Sphinx. Sphinx is a Python-based documentation generator and tool. Sphinx can extract documentation from code as well as build complete documentation from text files such as Restructured Text, Markdown, and UML. Images in many formats can be included. Output from Sphinx can be generated as HTML, PDF, Epub, and many other formats–all from the same source files. Output can include an index, table of contents, cross-references and an embedded search function.

This is intended to be interactive, so you're encouraged to bring a project along with you as Travis will be helping people out with the lab.

* Note that we are not affiliated or sponsored by the Huntsville-Madison County Public Library