Fixes missing Module Index in Sphinx-build
Change-Id: I3cf1ccce7f8e8138aacecbbb2d784ecca54809ac Closes-Bug: #1297432
This commit is contained in:
parent
fa31adf23e
commit
487d1eae1b
26
doc/source/agent.rst
Normal file
26
doc/source/agent.rst
Normal file
@ -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:
|
||||||
|
|
26
doc/source/api.rst
Normal file
26
doc/source/api.rst
Normal file
@ -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:
|
||||||
|
|
39
doc/source/backend.rst
Normal file
39
doc/source/backend.rst
Normal file
@ -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:
|
||||||
|
|
||||||
|
|
22
doc/source/central.rst
Normal file
22
doc/source/central.rst
Normal file
@ -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:
|
@ -85,7 +85,7 @@ exclude_patterns = []
|
|||||||
pygments_style = 'sphinx'
|
pygments_style = 'sphinx'
|
||||||
|
|
||||||
# A list of ignored prefixes for module index sorting.
|
# A list of ignored prefixes for module index sorting.
|
||||||
#modindex_common_prefix = []
|
modindex_common_prefix = ["designate."]
|
||||||
|
|
||||||
|
|
||||||
# -- Options for HTML output ---------------------------------------------------
|
# -- Options for HTML output ---------------------------------------------------
|
||||||
|
@ -30,6 +30,21 @@ also be found on the `OpenStack wiki`_.
|
|||||||
integrations
|
integrations
|
||||||
install
|
install
|
||||||
|
|
||||||
|
Source Documentation
|
||||||
|
====================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
|
||||||
|
agent
|
||||||
|
api
|
||||||
|
backend
|
||||||
|
central
|
||||||
|
mdns
|
||||||
|
objects
|
||||||
|
quota
|
||||||
|
sink
|
||||||
|
storage
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
45
doc/source/mdns.rst
Normal file
45
doc/source/mdns.rst
Normal file
@ -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:
|
||||||
|
|
174
doc/source/objects.rst
Normal file
174
doc/source/objects.rst
Normal file
@ -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:
|
||||||
|
|
||||||
|
|
27
doc/source/quota.rst
Normal file
27
doc/source/quota.rst
Normal file
@ -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:
|
||||||
|
|
||||||
|
|
17
doc/source/sink.rst
Normal file
17
doc/source/sink.rst
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
.. _sink:
|
||||||
|
|
||||||
|
****
|
||||||
|
Sink
|
||||||
|
****
|
||||||
|
|
||||||
|
.. _sink-service:
|
||||||
|
|
||||||
|
Sink Service
|
||||||
|
============
|
||||||
|
|
||||||
|
.. automodule:: designate.sink.service
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
|
17
doc/source/storage.rst
Normal file
17
doc/source/storage.rst
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
.. _storage:
|
||||||
|
|
||||||
|
*******
|
||||||
|
Storage
|
||||||
|
*******
|
||||||
|
|
||||||
|
.. _storage-base:
|
||||||
|
|
||||||
|
Storage Base
|
||||||
|
=============
|
||||||
|
|
||||||
|
.. automodule:: designate.storage.base
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user