From 487d1eae1be6ae8f67a2df3b32e1a217ec22bf38 Mon Sep 17 00:00:00 2001 From: Alok Jani Date: Thu, 25 Sep 2014 23:50:47 +0530 Subject: [PATCH] Fixes missing Module Index in Sphinx-build Change-Id: I3cf1ccce7f8e8138aacecbbb2d784ecca54809ac Closes-Bug: #1297432 --- doc/source/agent.rst | 26 ++++++ doc/source/api.rst | 26 ++++++ doc/source/backend.rst | 39 +++++++++ doc/source/central.rst | 22 ++++++ doc/source/conf.py | 2 +- doc/source/index.rst | 15 ++++ doc/source/mdns.rst | 45 +++++++++++ doc/source/objects.rst | 174 +++++++++++++++++++++++++++++++++++++++++ doc/source/quota.rst | 27 +++++++ doc/source/sink.rst | 17 ++++ doc/source/storage.rst | 17 ++++ 11 files changed, 409 insertions(+), 1 deletion(-) create mode 100644 doc/source/agent.rst create mode 100644 doc/source/api.rst create mode 100644 doc/source/backend.rst create mode 100644 doc/source/central.rst create mode 100644 doc/source/mdns.rst create mode 100644 doc/source/objects.rst create mode 100644 doc/source/quota.rst create mode 100644 doc/source/sink.rst create mode 100644 doc/source/storage.rst diff --git a/doc/source/agent.rst b/doc/source/agent.rst new file mode 100644 index 000000000..45201a777 --- /dev/null +++ b/doc/source/agent.rst @@ -0,0 +1,26 @@ +.. _agent: + +***** +Agent +***** + +.. _agent-rpcapi: + +Agent RPC API +============= + +.. automodule:: designate.agent.rpcapi + :members: + :undoc-members: + :show-inheritance: + +.. _agent-service: + +Agent RPC Service +================= + +.. automodule:: designate.agent.service + :members: + :undoc-members: + :show-inheritance: + diff --git a/doc/source/api.rst b/doc/source/api.rst new file mode 100644 index 000000000..46fd9e3c5 --- /dev/null +++ b/doc/source/api.rst @@ -0,0 +1,26 @@ +.. _api: + +*** +API +*** + +.. _api-middleware: + +API Middleware +=============== + +.. automodule:: designate.api.middleware + :members: + :undoc-members: + :show-inheritance: + +.. _api-service: + +API Service +=========== + +.. automodule:: designate.api.service + :members: + :undoc-members: + :show-inheritance: + diff --git a/doc/source/backend.rst b/doc/source/backend.rst new file mode 100644 index 000000000..e9ef6e71d --- /dev/null +++ b/doc/source/backend.rst @@ -0,0 +1,39 @@ +.. _backend: + +******* +Backend +******* + +Backend Base +============ + +.. automodule:: designate.backend.base + :members: + :undoc-members: + :show-inheritance: + +Backend Dynect +============== + +.. automodule:: designate.backend.impl_dynect + :members: + :undoc-members: + :show-inheritance: + +Backend Multi +============= + +.. automodule:: designate.backend.impl_multi + :members: + :undoc-members: + :show-inheritance: + +Backend Fake +============ + +.. automodule:: designate.backend.impl_fake + :members: + :undoc-members: + :show-inheritance: + + diff --git a/doc/source/central.rst b/doc/source/central.rst new file mode 100644 index 000000000..96bf230b9 --- /dev/null +++ b/doc/source/central.rst @@ -0,0 +1,22 @@ +.. _central: + +******* +Central +******* + +.. _rpcapi: + +Central RPC API +=============== +.. automodule:: designate.central.rpcapi + :members: + :undoc-members: + :show-inheritance: + +Central Service +=============== + +.. automodule:: designate.central.service + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/conf.py b/doc/source/conf.py index 8256a646d..3d2c09b49 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -85,7 +85,7 @@ exclude_patterns = [] pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +modindex_common_prefix = ["designate."] # -- Options for HTML output --------------------------------------------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 496a8abdd..6d7796203 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -30,6 +30,21 @@ also be found on the `OpenStack wiki`_. integrations install +Source Documentation +==================== + +.. toctree:: + :maxdepth: 3 + + agent + api + backend + central + mdns + objects + quota + sink + storage Indices and tables ================== diff --git a/doc/source/mdns.rst b/doc/source/mdns.rst new file mode 100644 index 000000000..9b040138e --- /dev/null +++ b/doc/source/mdns.rst @@ -0,0 +1,45 @@ +.. _mdns: + +**** +MDNS +**** + +MDNS Handler +============ +.. automodule:: designate.mdns.handler + :members: + :undoc-members: + :show-inheritance: + + +MDNS Middleware +=============== +.. automodule:: designate.mdns.middleware + :members: + :undoc-members: + :show-inheritance: + + +MDNS Notify +=========== +.. automodule:: designate.mdns.notify + :members: + :undoc-members: + :show-inheritance: + + +MDNS RPC API +============ +.. automodule:: designate.mdns.rpcapi + :members: + :undoc-members: + :show-inheritance: + + +MDNS Service +=============== +.. automodule:: designate.mdns.service + :members: + :undoc-members: + :show-inheritance: + diff --git a/doc/source/objects.rst b/doc/source/objects.rst new file mode 100644 index 000000000..52e864b0c --- /dev/null +++ b/doc/source/objects.rst @@ -0,0 +1,174 @@ +.. _objects: + +******* +Objects +******* + +Objects Base +============ +.. automodule:: designate.objects.base + :members: + :undoc-members: + :show-inheritance: + + +Objects Backlist +================ +.. automodule:: designate.objects.blacklist + :members: + :undoc-members: + :show-inheritance: + + +Objects Domain +============== +.. automodule:: designate.objects.domain + :members: + :undoc-members: + :show-inheritance: + + +Objects Quota +============= +.. automodule:: designate.objects.quota + :members: + :undoc-members: + :show-inheritance: + + +Objects Record +============== +.. automodule:: designate.objects.record + :members: + :undoc-members: + :show-inheritance: + + +Objects Recordset +================= +.. automodule:: designate.objects.recordset + :members: + :undoc-members: + :show-inheritance: + + +Objects Server +============== +.. automodule:: designate.objects.server + :members: + :undoc-members: + :show-inheritance: + + +Objects Tenant +============== +.. automodule:: designate.objects.tenant + :members: + :undoc-members: + :show-inheritance: + + +Objects TLD +=========== +.. automodule:: designate.objects.tld + :members: + :undoc-members: + :show-inheritance: + + +Objects TSigKey +=============== +.. automodule:: designate.objects.tsigkey + :members: + :undoc-members: + :show-inheritance: + + +Objects A Record +================ +.. automodule:: designate.objects.rrdata_a + :members: + :undoc-members: + :show-inheritance: + + +Objects AAAA Record +=================== +.. automodule:: designate.objects.rrdata_aaaa + :members: + :undoc-members: + :show-inheritance: + + +Objects CNAME Record +==================== +.. automodule:: designate.objects.rrdata_cname + :members: + :undoc-members: + :show-inheritance: + + +Objects MX Record +================= +.. automodule:: designate.objects.rrdata_mx + :members: + :undoc-members: + :show-inheritance: + + +Objects NS Record +================= +.. automodule:: designate.objects.rrdata_ns + :members: + :undoc-members: + :show-inheritance: + + +Objects PTR Record +================== +.. automodule:: designate.objects.rrdata_ptr + :members: + :undoc-members: + :show-inheritance: + + +Objects SOA Record +================== +.. automodule:: designate.objects.rrdata_soa + :members: + :undoc-members: + :show-inheritance: + + +Objects SPF Record +================== +.. automodule:: designate.objects.rrdata_spf + :members: + :undoc-members: + :show-inheritance: + + +Objects SRV Record +================== +.. automodule:: designate.objects.rrdata_srv + :members: + :undoc-members: + :show-inheritance: + + +Objects TXT Record +================== +.. automodule:: designate.objects.rrdata_txt + :members: + :undoc-members: + :show-inheritance: + + +Objects SSHFP Record +==================== +.. automodule:: designate.objects.rrdata_sshfp + :members: + :undoc-members: + :show-inheritance: + + diff --git a/doc/source/quota.rst b/doc/source/quota.rst new file mode 100644 index 000000000..b6a881d7a --- /dev/null +++ b/doc/source/quota.rst @@ -0,0 +1,27 @@ +.. _quota: + +***** +Quota +***** + +.. _quota-base: + +Quota Base +========== + +.. automodule:: designate.quota.base + :members: + :undoc-members: + :show-inheritance: + +.. _quota-storage: + +Quota Storage +============= + +.. automodule:: designate.quota.impl_storage + :members: + :undoc-members: + :show-inheritance: + + diff --git a/doc/source/sink.rst b/doc/source/sink.rst new file mode 100644 index 000000000..2fca6b260 --- /dev/null +++ b/doc/source/sink.rst @@ -0,0 +1,17 @@ +.. _sink: + +**** +Sink +**** + +.. _sink-service: + +Sink Service +============ + +.. automodule:: designate.sink.service + :members: + :undoc-members: + :show-inheritance: + + diff --git a/doc/source/storage.rst b/doc/source/storage.rst new file mode 100644 index 000000000..52108913b --- /dev/null +++ b/doc/source/storage.rst @@ -0,0 +1,17 @@ +.. _storage: + +******* +Storage +******* + +.. _storage-base: + +Storage Base +============= + +.. automodule:: designate.storage.base + :members: + :undoc-members: + :show-inheritance: + +