Browse Source

Enable warning-is-error in doc build

Change-Id: I1ec46ed4e479e602f69695ba60ebb6968b2aa6b8
changes/13/480313/1
Akihiro Motoki 4 years ago
parent
commit
6580d73811
  1. 2
      README.rst
  2. 6
      doc/source/design/api.rst
  3. 4
      doc/source/design/command-lines.rst
  4. 7
      doc/source/functionality/bgp-speaker.rst
  5. 2
      doc/source/functionality/route-advertisement.rst
  6. 1
      doc/source/readme.rst
  7. 3
      setup.cfg

2
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>
https://git.openstack.org/cgit/openstack/neutron-dynamic-routing
Refer to Neutron documentation for more information:
`Neutron README.rst <https://git.openstack.org/cgit/openstack/neutron/tree/README.rst>`_

6
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

4
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.
repeat this option.

7
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 <SPEAKER NAME/ID>``
``neutron bgp-speaker-delete <SPEAKER NAME/ID>``
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 <DRAGENT ID> <SPEAKER NAME/ID>``
``neutron bgp-dragent-speaker-remove <DRAGENT ID> <SPEAKER NAME/ID>``
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>`_.
For details refer to `Testing <../others/testing.html>`_.

2
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 <created-bgp-speaker>``
``neutron bgp-speaker-advertiseroute-list <created-bgp-speaker>``
It does a complicated db query to generate the list of advertised routes.
For more details refer to `route advertisement db lookup <https://git.openstack.org/cgit/openstack/neutron-dynamic-routing/tree/neutron_dynamic_routing/db/bgp_db.py#n462>`_

1
doc/source/readme.rst

@ -1 +0,0 @@
.. include:: ../../README.rst

3
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

Loading…
Cancel
Save