commit cfff549390aa379d3a8682e2ab868288ec119c3d Author: Isis Lovecruft isis@torproject.org Date: Thu Nov 28 06:30:24 2013 +0000
Include Sphinx documentation for gen_bridge_descriptors script. --- doc/sphinx/source/bridgedb.rst | 1 + doc/sphinx/source/conf.py | 4 ++-- doc/sphinx/source/gen_bridge_descriptors.rst | 7 +++++++ 3 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/doc/sphinx/source/bridgedb.rst b/doc/sphinx/source/bridgedb.rst index 13cb223..0b8d5fe 100644 --- a/doc/sphinx/source/bridgedb.rst +++ b/doc/sphinx/source/bridgedb.rst @@ -22,4 +22,5 @@ bridgedb :ref:`bridgedb.Storage <Storage>` bridgedb.Tests bridgedb.Util + gen_bridge_descriptors
diff --git a/doc/sphinx/source/conf.py b/doc/sphinx/source/conf.py index 4011deb..187bf49 100644 --- a/doc/sphinx/source/conf.py +++ b/doc/sphinx/source/conf.py @@ -41,7 +41,7 @@ import bridgedb.Storage import bridgedb.test import bridgedb.Tests import bridgedb.Util - +import gen_bridge_descriptors
class Mock(object): """Used to fake the presence of Python C-extensions for documentation @@ -80,7 +80,7 @@ autoclass_content = 'both' # -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = '1.0' +needs_sphinx = '1.1'
# Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. diff --git a/doc/sphinx/source/gen_bridge_descriptors.rst b/doc/sphinx/source/gen_bridge_descriptors.rst new file mode 100644 index 0000000..604075f --- /dev/null +++ b/doc/sphinx/source/gen_bridge_descriptors.rst @@ -0,0 +1,7 @@ +gen_bridge_descriptors +---------------------- + +.. automodule:: gen_bridge_descriptors + :members: + :undoc-members: + :show-inheritance: