diff --git a/designate/tests/resources/sample_notifications/neutron/port.create.start.josn b/designate/tests/resources/sample_notifications/neutron/port.create.start.json similarity index 100% rename from designate/tests/resources/sample_notifications/neutron/port.create.start.josn rename to designate/tests/resources/sample_notifications/neutron/port.create.start.json diff --git a/doc/source/admin-guide/notifications.rst b/doc/source/admin-guide/notifications.rst index c2f2619a..743a78e1 100644 --- a/doc/source/admin-guide/notifications.rst +++ b/doc/source/admin-guide/notifications.rst @@ -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` diff --git a/doc/source/admin-guide/pools.rst b/doc/source/admin-guide/pools.rst index de71da86..ce001447 100644 --- a/doc/source/admin-guide/pools.rst +++ b/doc/source/admin-guide/pools.rst @@ -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 diff --git a/doc/source/developer-docs/architecture.rst b/doc/source/developer-docs/architecture.rst index 35574cf4..2c201d20 100644 --- a/doc/source/developer-docs/architecture.rst +++ b/doc/source/developer-docs/architecture.rst @@ -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. diff --git a/doc/source/developer-docs/devstack.rst b/doc/source/developer-docs/devstack.rst index 2ed3e2da..80923d6b 100644 --- a/doc/source/developer-docs/devstack.rst +++ b/doc/source/developer-docs/devstack.rst @@ -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:: diff --git a/doc/source/developer-docs/integrations.rst b/doc/source/developer-docs/integrations.rst index fee5cef9..ee909f50 100644 --- a/doc/source/developer-docs/integrations.rst +++ b/doc/source/developer-docs/integrations.rst @@ -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 ====================== diff --git a/doc/source/developer-docs/sourcedoc.rst b/doc/source/developer-docs/sourcedoc.rst index 1ab95b48..f9ee9581 100644 --- a/doc/source/developer-docs/sourcedoc.rst +++ b/doc/source/developer-docs/sourcedoc.rst @@ -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 diff --git a/doc/source/developer-docs/ubuntu-dev.rst b/doc/source/developer-docs/ubuntu-dev.rst index 1f84605f..fdd941a2 100644 --- a/doc/source/developer-docs/ubuntu-dev.rst +++ b/doc/source/developer-docs/ubuntu-dev.rst @@ -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 diff --git a/setup.cfg b/setup.cfg index 570e8411..058906f2 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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 =