openstack/python-openstackclient
Code Issues Proposed changes

Add redirect testing

Browse Source 
Adds a dependency on and invocation of the `whereto` command to validate
redirects in the .htaccess file during doc builds.

Change-Id: Ib6cc2953f0fd774de3c3a0c8a2bd6cff49667c14
This commit is contained in:
Eric Fried 2019-11-04 17:42:57 -06:00
parent c6266b5ab2
commit 6f07828bf0
3 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/requirements.txt
View File

@ -7,6 +7,9 @@ sphinx!=1.6.6,!=1.6.7,>=1.6.5,<2.0.0;python_version=='2.7' # BSD
sphinx!=1.6.6,!=1.6.7,>=1.6.5;python_version>='3.4' # BSD sphinx!=1.6.6,!=1.6.7,>=1.6.5;python_version>='3.4' # BSD
sphinxcontrib-apidoc>=0.2.0 # BSD sphinxcontrib-apidoc>=0.2.0 # BSD
# redirect tests in docs
whereto>=0.4.0 # Apache-2.0
# Install these to generate sphinx autodocs # Install these to generate sphinx autodocs
aodhclient>=0.9.0 # Apache-2.0 aodhclient>=0.9.0 # Apache-2.0
gnocchiclient>=3.3.1 # Apache-2.0 gnocchiclient>=3.3.1 # Apache-2.0

18
doc/test/redirect-tests.txt Normal file
View File

@ -0,0 +1,18 @@
/python-openstackclient/latest/command-objects/this-is-a-test.html 301 /python-openstackclient/latest/cli/command-objects/this-is-a-test.html
/python-openstackclient/latest/authentication.html 301 /python-openstackclient/latest/cli/authentication.html
/python-openstackclient/latest/backward-incompatible.html 301 /python-openstackclient/latest/cli/backward-incompatible.html
/python-openstackclient/latest/command-list.html 301 /python-openstackclient/latest/cli/command-list.html
/python-openstackclient/latest/commands.html 301 /python-openstackclient/latest/cli/commands.html
/python-openstackclient/latest/decoder.html 301 /python-openstackclient/latest/cli/decoder.html
/python-openstackclient/latest/interactive.html 301 /python-openstackclient/latest/cli/interactive.html
/python-openstackclient/latest/plugin-commands.html 301 /python-openstackclient/latest/cli/plugin-commands.html
/python-openstackclient/latest/specs/this-is-a-test.html 301 /python-openstackclient/latest/contributor/specs/this-is-a-test.html
/python-openstackclient/latest/command-beta.html 301 /python-openstackclient/latest/contributor/command-beta.html
/python-openstackclient/latest/command-errors.html 301 /python-openstackclient/latest/contributor/command-errors.html
/python-openstackclient/latest/command-logs.html 301 /python-openstackclient/latest/contributor/command-logs.html
/python-openstackclient/latest/command-options.html 301 /python-openstackclient/latest/contributor/command-options.html
/python-openstackclient/latest/command-wrappers.html 301 /python-openstackclient/latest/contributor/command-wrappers.html
/python-openstackclient/latest/developing.html 301 /python-openstackclient/latest/contributor/developing.html
/python-openstackclient/latest/humaninterfaceguide.html 301 /python-openstackclient/latest/contributor/humaninterfaceguide.html
/python-openstackclient/latest/plugins.html 301 /python-openstackclient/latest/contributor/plugins.html
/python-openstackclient/latest/cli/plugin-commands.html 301 /python-openstackclient/latest/cli/plugin-commands/index.html

2
tox.ini
View File

@ -118,6 +118,8 @@ deps =
commands = commands =
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
sphinx-build -a -E -W -d doc/build/doctrees -b man doc/source doc/build/man sphinx-build -a -E -W -d doc/build/doctrees -b man doc/source doc/build/man
# Validate redirects (must be done after the docs build
whereto doc/build/html/.htaccess doc/test/redirect-tests.txt
[testenv:releasenotes] [testenv:releasenotes]
basepython = python3 basepython = python3