aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMark Goddard <mark@stackhpc.com>2020-09-17 17:47:55 +0100
committerMark Goddard <mark@stackhpc.com>2020-09-17 17:47:55 +0100
commit1f71b5f0d91dab7d22569413254f0a8ebc9ffbcc (patch)
tree177fd21f4422e14a37114a32c27877bcb75384d1 /doc
parentb49c86848dcd8d256e54d424d917a3b3b94d2d2c (diff)
downloadkolla-ansible-1f71b5f0d91dab7d22569413254f0a8ebc9ffbcc.tar.gz
kolla-ansible-1f71b5f0d91dab7d22569413254f0a8ebc9ffbcc.zip
docs: add scaffolding for redirects
This allows us to move pages around without breaking links. Change-Id: Id2be1e6aba9fba376cf217b558ca922d8db1da28
Diffstat (limited to 'doc')
-rw-r--r--doc/requirements.txt1
-rw-r--r--doc/source/_extra/.htaccess1
-rw-r--r--doc/source/conf.py4
-rw-r--r--doc/test/redirect-tests.txt1
4 files changed, 7 insertions, 0 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 66568ffb1..da3f3abff 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 000000000..db56ac3ad
--- /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 f10c47e99..9a12a93c7 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 000000000..db56ac3ad
--- /dev/null
+++ b/doc/test/redirect-tests.txt
@@ -0,0 +1 @@
+# No redirects in place yet.