Our documentation could be much nicer if we use a more sophisticated toolset.
There are several things that we'd like to be able to do, such as the following:
- Fine-tune the presentation to include emphasis such as bold, italic, or color.
- Provide the semantic markup for the parameters, return values, exceptions, and cross-references among Python objects.
- Provide a link to view the source code.
- Filter the code that's included or rejected. This includes fine-tuning the presence of standard library modules, private objects with a leading _, system objects with a leading __, or superclass members.
- Adjust the CSS to provide a different style for the resulting HTML pages.
We can address the first two requirements through more sophisticated markup in our docstrings. We'll need to use the RST markup language, and we'll also need an additional...
