Improving check warning build_sphinx
- With this PS, we could be received a warning error at same time when build sphinx decumentation of Designate via: $ python setup.py build_sphinx - Fix some issues with docs sphinx. Change-Id: I1e5a8c4b45dc3d10028531eabb50d3d6189ea070
This commit is contained in:
parent
877d7818d6
commit
f7e8a71b02
|
@ -65,7 +65,7 @@ Format
|
||||||
|
|
||||||
An example notification from Neutron:
|
An example notification from Neutron:
|
||||||
|
|
||||||
.. literalinclude:: ../../designate/tests/resources/sample_notifications/neutron/port.delete.start.json
|
.. literalinclude:: ../../../designate/tests/resources/sample_notifications/neutron/port.delete.start.json
|
||||||
|
|
||||||
More examples can be found at :file:`designate/tests/resources/sample_notifications`
|
More examples can be found at :file:`designate/tests/resources/sample_notifications`
|
||||||
|
|
||||||
|
|
|
@ -84,7 +84,7 @@ In mitaka we moved the method of updating pools to a CLI in `designate-manage`
|
||||||
There is a YAML file that defines the pool, and is used to load this information into the database.
|
There is a YAML file that defines the pool, and is used to load this information into the database.
|
||||||
|
|
||||||
|
|
||||||
.. literalinclude:: ../../etc/designate/pools.yaml.sample
|
.. literalinclude:: ../../../etc/designate/pools.yaml.sample
|
||||||
:language: yaml
|
:language: yaml
|
||||||
|
|
||||||
Designate Manage Pools Command Reference
|
Designate Manage Pools Command Reference
|
||||||
|
|
|
@ -27,7 +27,7 @@ Designate provides multi-tenant DNS as a Service. Designate provides a REST API,
|
||||||
High Level Topology
|
High Level Topology
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|
||||||
.. image:: images/Designate-Arch.png
|
.. image:: ../images/Designate-Arch.png
|
||||||
|
|
||||||
.. _designate-api:
|
.. _designate-api:
|
||||||
|
|
||||||
|
@ -67,7 +67,7 @@ The current implemented tasks in producer include emitting dns.zone.exists event
|
||||||
|
|
||||||
Designate Sink
|
Designate Sink
|
||||||
-----------------------
|
-----------------------
|
||||||
designate-sink is an optional service which listens for event :doc:`notifications`, such as compute.instance.create.end, handlers are available for Nova and Neutron. Notification events can then be used to trigger record creation & deletion.
|
designate-sink is an optional service which listens for event :doc: ../notifications, such as compute.instance.create.end, handlers are available for Nova and Neutron. Notification events can then be used to trigger record creation & deletion.
|
||||||
|
|
||||||
The current sink implementations generate simple forward lookup A records, using a format specified in handler-nova configuration. Any field in the event notification can be used to generate a record.
|
The current sink implementations generate simple forward lookup A records, using a format specified in handler-nova configuration. Any field in the event notification can be used to generate a record.
|
||||||
|
|
||||||
|
|
|
@ -42,7 +42,7 @@ Instructions
|
||||||
|
|
||||||
4. Create a `local.conf` config file:
|
4. Create a `local.conf` config file:
|
||||||
|
|
||||||
.. literalinclude:: ../../contrib/vagrant/local.conf
|
.. literalinclude:: ../../../contrib/vagrant/local.conf
|
||||||
:language: bash
|
:language: bash
|
||||||
|
|
||||||
5. Run DevStack::
|
5. Run DevStack::
|
||||||
|
|
|
@ -1,3 +1,20 @@
|
||||||
|
:orphan:
|
||||||
|
|
||||||
|
..
|
||||||
|
Copyright 2013 Rackspace Hosting
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
======================
|
======================
|
||||||
OpenStack Integrations
|
OpenStack Integrations
|
||||||
======================
|
======================
|
||||||
|
|
|
@ -4,12 +4,12 @@ Source Code Documentation
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 3
|
:maxdepth: 3
|
||||||
|
|
||||||
sourcedoc/api
|
../sourcedoc/api
|
||||||
sourcedoc/backend
|
../sourcedoc/backend
|
||||||
sourcedoc/central
|
../sourcedoc/central
|
||||||
sourcedoc/mdns
|
../sourcedoc/mdns
|
||||||
sourcedoc/objects
|
../sourcedoc/objects
|
||||||
sourcedoc/quota
|
../sourcedoc/quota
|
||||||
sourcedoc/sink
|
../sourcedoc/sink
|
||||||
sourcedoc/storage
|
../sourcedoc/storage
|
||||||
|
|
||||||
|
|
|
@ -128,7 +128,7 @@ Create the designate.conf file
|
||||||
|
|
||||||
Copy or mirror the configuration from this sample file here:
|
Copy or mirror the configuration from this sample file here:
|
||||||
|
|
||||||
.. literalinclude:: ./examples/basic-config-sample.conf
|
.. literalinclude:: ../examples/basic-config-sample.conf
|
||||||
:language: ini
|
:language: ini
|
||||||
|
|
||||||
|
|
||||||
|
@ -257,7 +257,7 @@ Create the pools.yaml file
|
||||||
|
|
||||||
Copy or mirror the configuration from this sample file here:
|
Copy or mirror the configuration from this sample file here:
|
||||||
|
|
||||||
.. literalinclude:: ./examples/basic-pools-sample.yaml
|
.. literalinclude:: ../examples/basic-pools-sample.yaml
|
||||||
:language: yaml
|
:language: yaml
|
||||||
|
|
||||||
Initialize the Database
|
Initialize the Database
|
||||||
|
|
Loading…
Reference in New Issue