Sphinx autodoc: automated API documentation
Speaker
Takayuki Shimizukawa /English
Tags
sphinx, documentation, autodoc,Abstract
Using the automated documentation feature of Sphinx, you can make with ease the extensive documentation of Python program.
You just write python function documents (docstrings), Sphinx organizes them into the document, can be converted to a variety of formats.
In this session, I'll explain a documentation procedure that uses with sphinx autodoc and autosummary extensions.
About Speaker
* Sphinx co-maintainer since 2011
* "Let's start Sphinx" Japanese ebook author
* Sphinx-users.jp account
* PyCon JP organizer