Building Documentation with Sphinx
OverviewTeaching: 0 min
Exercises: 0 minQuestions
How can I make my documentation more accessibleObjectives
Build a documentation website with sphinx
Add overview documentation
Distribute a sphinx documentation site
Sphinx is a tool for building documentation.
What does sphinx produce?
In a group, have each member open one of the following packages’ documentation
Discuss what the common components are, what is helpful about these documentation sites, how they address the general concepts on documentation, how they’re similar and how they’re different.
these all use sphinx to generate them?
FIXME: guide through setup and what options mean
Adding literal documentation
FIXME: RST overview
FIXME: adding pages
Add an api line to the
indnex.rst so that it has a link to it.
The create an API.rst file:
API documentation ==================
Building documentation into a website is a common way of distributing it
Sphinx will auto build a website from plain text files and your docstrings