From 6580d73811c3f76094b5b30ccfa0c25bff7f2eb8 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Sat, 1 Jul 2017 20:44:41 +0000 Subject: [PATCH] Enable warning-is-error in doc build Change-Id: I1ec46ed4e479e602f69695ba60ebb6968b2aa6b8 --- README.rst | 2 +- doc/source/design/api.rst | 6 ++++-- doc/source/design/command-lines.rst | 4 ++-- doc/source/functionality/bgp-speaker.rst | 7 ++++--- doc/source/functionality/route-advertisement.rst | 2 +- doc/source/readme.rst | 1 - setup.cfg | 3 ++- 7 files changed, 14 insertions(+), 11 deletions(-) delete mode 100644 doc/source/readme.rst diff --git a/README.rst b/README.rst index ec87edcb..2939ad65 100644 --- a/README.rst +++ b/README.rst @@ -18,7 +18,7 @@ site for asking for help, and filing bugs. We use a single launchpad page for all Neutron projects. Code is available on git.openstack.org at: - +https://git.openstack.org/cgit/openstack/neutron-dynamic-routing Refer to Neutron documentation for more information: `Neutron README.rst `_ diff --git a/doc/source/design/api.rst b/doc/source/design/api.rst index 021fe15d..0489af46 100644 --- a/doc/source/design/api.rst +++ b/doc/source/design/api.rst @@ -32,7 +32,8 @@ in neutron. Using the ReST interface, a cloud administrator can define routing peers and advertise neutron routes outside the OpenStack domain. .. note:: - Currently, only the support for BGP dynamic routing protocol is available. + + Currently, only the support for BGP dynamic routing protocol is available. Data Model ---------- @@ -86,7 +87,8 @@ Different ReST interface are exposed for realizing different dynamic protocol functionality. .. note:: -Only an administrator have the access to the exposed API's. + + Only an administrator have the access to the exposed API's. BGP diff --git a/doc/source/design/command-lines.rst b/doc/source/design/command-lines.rst index 19c47187..4ff0337e 100644 --- a/doc/source/design/command-lines.rst +++ b/doc/source/design/command-lines.rst @@ -117,7 +117,7 @@ Optional Arguments repeat this option. BGP Speaker Show ----------------- +~~~~~~~~~~~~~~~~ .. code-block:: console @@ -620,4 +620,4 @@ Optional Arguments ``-F FIELD, --field FIELD`` Specify the field(s) to be returned by server. You can - repeat this option. \ No newline at end of file + repeat this option. diff --git a/doc/source/functionality/bgp-speaker.rst b/doc/source/functionality/bgp-speaker.rst index d7f77447..e1c50050 100644 --- a/doc/source/functionality/bgp-speaker.rst +++ b/doc/source/functionality/bgp-speaker.rst @@ -83,6 +83,7 @@ One needs to ensure below points for setting a BGP connection. automatically as the highest IP address configured for the local interfaces. Just a suggestion, please make sure that it is the same as the ``peer_ip`` which you configure in Neutron for distinguishing easily. + ``local_as`` Autonomous System number can be same or different from the AS_id of external BGP router. AS_id will be same for iBGP and different for eBGP sessions. @@ -150,12 +151,12 @@ Then the following operation could be done. The same logic with below, but it is reverse. If you don't want use the specific BGP Speaker anymore, you can use CLI: - ``neutron bgp-speaker-delete `` +``neutron bgp-speaker-delete `` BGP Plugin will find all the associated Dragent and send RPC ``bgp_speaker_remove_end`` to make the Dragents to clean the ``BGP Speaker`` instances. This is the same with CLI: - ``neutron bgp-dragent-speaker-remove `` +``neutron bgp-dragent-speaker-remove `` BGP Plugin just send rpc ``bgp_speaker_remove_end`` to the specific Dragent. Advertisement @@ -164,4 +165,4 @@ For details refer to `Route Advertisement <./route-advertisement.html>`_. How to work ----------- -For details refer to `Testing <../others/testing.html>`_. \ No newline at end of file +For details refer to `Testing <../others/testing.html>`_. diff --git a/doc/source/functionality/route-advertisement.rst b/doc/source/functionality/route-advertisement.rst index b1a068a7..8252ed0e 100644 --- a/doc/source/functionality/route-advertisement.rst +++ b/doc/source/functionality/route-advertisement.rst @@ -111,6 +111,6 @@ callbacks does this work. on tenants' network routes change. You could get the advertisement routes of specific BGP Speaker like: - ``neutron bgp-speaker-advertiseroute-list `` +``neutron bgp-speaker-advertiseroute-list `` It does a complicated db query to generate the list of advertised routes. For more details refer to `route advertisement db lookup `_ diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index a6210d3d..00000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst diff --git a/setup.cfg b/setup.cfg index 1386ea9f..8c3e3739 100644 --- a/setup.cfg +++ b/setup.cfg @@ -41,9 +41,10 @@ tempest.test_plugins = neutron_dynamic_routing = neutron_dynamic_routing.tests.tempest.plugin:NeutronDynamicRoutingTempestPlugin [build_sphinx] -all_files = 1 +all-files = 1 build-dir = doc/build source-dir = doc/source +warning-is-error = 1 [extract_messages] keywords = _ gettext ngettext l_ lazy_gettext