Documenting ztm.topicmaps

We use Sphinx to generate the documentation. We write all documentation in reStructuredText.

Documentation is written in two places.

API documentation

API documentation is assembled from docstrings as reStructuredText but still rendered with Sphinx.

Explanatory documentation

Textual documentation is generated from reStructuredText documents inside ztm.topicmaps/src/ztm/topicmaps/doc/. The examples are written in doctest style and are self-testing.

Table Of Contents

Previous topic

Architectural overview of ztm.topicmaps

Next topic

Running and extending tests

This Page