openstack
/
designate
Code Issues Proposed changes

Merge "Improving check warning build_sphinx"

This commit is contained in:
Jenkins 2017-06-28 18:22:47 +00:00 committed by Gerrit Code Review
parent 8eea30cb03 f7e8a71b02
commit f6e6c7fca4
9 changed files with 33 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
designate/tests/resources/sample_notifications/neutron/port.create.start.josn → designate/tests/resources/sample_notifications/neutron/port.create.start.json
View File

2
doc/source/admin-guide/notifications.rst
View File

@ -65,7 +65,7 @@ Format
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`

2
doc/source/admin-guide/pools.rst
View File

@ -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.
.. literalinclude:: ../../etc/designate/pools.yaml.sample
.. literalinclude:: ../../../etc/designate/pools.yaml.sample
:language: yaml
Designate Manage Pools Command Reference

4
doc/source/developer-docs/architecture.rst
View File

@ -27,7 +27,7 @@ Designate provides multi-tenant DNS as a Service. Designate provides a REST API,
High Level Topology
-----------------------
.. image:: images/Designate-Arch.png
.. image:: ../images/Designate-Arch.png
.. _designate-api:
@ -67,7 +67,7 @@ The current implemented tasks in producer include emitting dns.zone.exists event
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.

2
doc/source/developer-docs/devstack.rst
View File

@ -42,7 +42,7 @@ Instructions
4. Create a `local.conf` config file:
.. literalinclude:: ../../contrib/vagrant/local.conf
.. literalinclude:: ../../../contrib/vagrant/local.conf
:language: bash
5. Run DevStack::

17
doc/source/developer-docs/integrations.rst
View File

@ -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
======================

16
doc/source/developer-docs/sourcedoc.rst
View File

@ -4,12 +4,12 @@ Source Code Documentation
.. toctree::
:maxdepth: 3
sourcedoc/api
sourcedoc/backend
sourcedoc/central
sourcedoc/mdns
sourcedoc/objects
sourcedoc/quota
sourcedoc/sink
sourcedoc/storage
../sourcedoc/api
../sourcedoc/backend
../sourcedoc/central
../sourcedoc/mdns
../sourcedoc/objects
../sourcedoc/quota
../sourcedoc/sink
../sourcedoc/storage

4
doc/source/developer-docs/ubuntu-dev.rst
View File

@ -128,7 +128,7 @@ Create the designate.conf file
Copy or mirror the configuration from this sample file here:
.. literalinclude:: ./examples/basic-config-sample.conf
.. literalinclude:: ../examples/basic-config-sample.conf
:language: ini
@ -257,7 +257,7 @@ Create the pools.yaml file
Copy or mirror the configuration from this sample file here:
.. literalinclude:: ./examples/basic-pools-sample.yaml
.. literalinclude:: ../examples/basic-pools-sample.yaml
:language: yaml
Initialize the Database

1
setup.cfg
View File

@ -146,6 +146,7 @@ designate.notification.plugin =
all_files = 1
build-dir = doc/build
source-dir = doc/source
warning-is-error = 1
[egg_info]
tag_build =