RstDoc Package Index
- Package rstdoc:
- Module __init__: The rstdoc package implements documentation
command extensions` for SetupTools setup scripts and
a TracPlugin that provides documentation in the same format.
- Module plugin: This module implements the Trac components for the
RstDoc TracPlugin.
- Module release: Release information for the RstDoc distribution.
- Module setuplib: Command extensions for SetupTools setup scripts.
- Module test_all: UnitTests for rstdoc package.
- Package rstdoc.misclibs:
- Module __init__: General purpose utilities
- Module functional: Iterator and functional programming tools.
Most of the iterator methods were copied from the
Python itertools documentation with added docstrings
to show example usage.
- Module test_all: UnitTests for misclibs package.
- Module util: Utility methods and classes.
- Package rstdoc.rstlib:
- Module __init__: Utilities to produce RestructuredText-based documentation.
- Module astdoc: Creates RestructuredText-based documentation for Python
modules and docstrings by parsing AbstractSyntaxTrees generated by
the Python compiler.
- Module astwriter: Generate Python source from AbstractSyntaxTrees generated
by the compiler.
- File rstdoc/rstlib/default.css
- Module htmlwriter: RestructuredText Html Writer, based upon the one provided
with docutils.
- File rstdoc/rstlib/package_docs.css
- Module test_all: UnitTests for the rstlib package.
- Package rstdoc.traclib:
- Module __init__: Utilities for processing trac wiki syntax as
reStructured text. This allows Python docstrings
to reference TracWiki pages -- just like this one did.
- Module roles: reStructured text interpreted text roles for TracLinks.
- Module test_all: Unit Tests for the traclib package.
- Module test_wiki_filter: Unit Tests for the wiki_filter module.
- Module wiki_filter: Convert TracLinks into RestructuredText roles. The
following examples illustrate the use of TracLinks in
Python DocStrings.