From 1f71b5f0d91dab7d22569413254f0a8ebc9ffbcc Mon Sep 17 00:00:00 2001 From: Mark Goddard Date: Thu, 17 Sep 2020 17:47:55 +0100 Subject: [PATCH] docs: add scaffolding for redirects This allows us to move pages around without breaking links. Change-Id: Id2be1e6aba9fba376cf217b558ca922d8db1da28 --- doc/requirements.txt | 1 + doc/source/_extra/.htaccess | 1 + doc/source/conf.py | 4 ++++ doc/test/redirect-tests.txt | 1 + tox.ini | 1 + 5 files changed, 8 insertions(+) create mode 100644 doc/source/_extra/.htaccess create mode 100644 doc/test/redirect-tests.txt diff --git a/doc/requirements.txt b/doc/requirements.txt index 66568ffb19..da3f3abff7 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -9,3 +9,4 @@ openstackdocstheme>=2.2.1 # Apache-2.0 reno>=3.1.0 # Apache-2.0 sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD +whereto>=0.3.0 # Apache-2.0 diff --git a/doc/source/_extra/.htaccess b/doc/source/_extra/.htaccess new file mode 100644 index 0000000000..db56ac3ade --- /dev/null +++ b/doc/source/_extra/.htaccess @@ -0,0 +1 @@ +# No redirects in place yet. diff --git a/doc/source/conf.py b/doc/source/conf.py index f10c47e994..9a12a93c7c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -58,6 +58,10 @@ pygments_style = 'native' html_theme = 'openstackdocs' # html_static_path = ['static'] +# Add any paths that contain "extra" files, such as .htaccess or +# robots.txt. +html_extra_path = ['_extra'] + html_theme_options = { "show_other_versions": True, } diff --git a/doc/test/redirect-tests.txt b/doc/test/redirect-tests.txt new file mode 100644 index 0000000000..db56ac3ade --- /dev/null +++ b/doc/test/redirect-tests.txt @@ -0,0 +1 @@ +# No redirects in place yet. diff --git a/tox.ini b/tox.ini index c1e5537ad1..364a43e959 100644 --- a/tox.ini +++ b/tox.ini @@ -50,6 +50,7 @@ deps = commands = rm -rf doc/build sphinx-build -W --keep-going -b html doc/source doc/build/html + whereto doc/source/_extra/.htaccess doc/test/redirect-tests.txt [testenv:deploy-guide] deps = {[testenv:docs]deps}