From 2dc98bf4af6d14d50b0b7f2a2b5f0bed226bd77f Mon Sep 17 00:00:00 2001 From: Boden R Date: Mon, 23 Apr 2018 11:24:08 -0600 Subject: [PATCH] fix docs/links for 1.14.0 release This patch addresses the following issues in prep for the neutron-lib 1.14.0 release: - Updates the tox linkcheck target to get it working. - Removes the glob for modules/* in doc/source/reference/index.rst as this causes local build errors when not finding anything with the glob. - Fixes any issues found by running the linkcheck tox target. Change-Id: I0e96068cd7b6733adc35503b40500b80692cfd6d --- api-ref/source/v2/intro.inc | 8 ++++---- doc/source/reference/index.rst | 3 --- tox.ini | 5 ++++- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/api-ref/source/v2/intro.inc b/api-ref/source/v2/intro.inc index dd50d5323..518eb0b08 100644 --- a/api-ref/source/v2/intro.inc +++ b/api-ref/source/v2/intro.inc @@ -91,12 +91,12 @@ The Networking API v2.0 always responds with the JSON data serialization format. The ``Accept`` header is ignored. Query extension - A ``.json`` extension can be added to the request URI. For example, the - ``.json`` extension in the following requests are equivalent: +A ``.json`` extension can be added to the request URI. For example, the +``.json`` extension in the following requests are equivalent: - - ``GET`` *publicURL*/networks +- GET *publicURL*/networks - - ``GET`` *publicURL*/networks.json +- GET *publicURL*/networks.json Tenant and project attributes in responses ------------------------------------------ diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 9d1af1c09..b17508b9b 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -25,9 +25,6 @@ Module Reference .. toctree:: :maxdepth: 1 - :glob: - - modules/* * :ref:`genindex` * :ref:`search` diff --git a/tox.ini b/tox.ini index 45f54d332..78a995feb 100644 --- a/tox.ini +++ b/tox.ini @@ -50,12 +50,15 @@ commands = sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html [testenv:linkcheck] +deps = + -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} + -r{toxinidir}/requirements.txt + -r{toxinidir}/doc/requirements.txt whitelist_externals = rm commands = rm -rf api-ref/build sphinx-build -W -b linkcheck api-ref/source api-ref/build/linkcheck rm -rf doc/build - python setup.py build_sphinx sphinx-build -W -b linkcheck doc/source doc/build/linkcheck [testenv:debug]