openstack/kolla-ansible
Code Issues Proposed changes

docs: add scaffolding for redirects

Browse Source 
This allows us to move pages around without breaking links.

Change-Id: Id2be1e6aba9fba376cf217b558ca922d8db1da28
This commit is contained in:
Mark Goddard 2020-09-17 17:47:55 +01:00
parent b49c86848d
commit 1f71b5f0d9
5 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/requirements.txt
View File

@ -9,3 +9,4 @@ openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
whereto>=0.3.0 # Apache-2.0

1
doc/source/_extra/.htaccess Normal file
View File

@ -0,0 +1 @@
# No redirects in place yet.

4
doc/source/conf.py
View File

@ -58,6 +58,10 @@ pygments_style = 'native'
html_theme = 'openstackdocs' html_theme = 'openstackdocs'
# html_static_path = ['static'] # html_static_path = ['static']
# Add any paths that contain "extra" files, such as .htaccess or
# robots.txt.
html_extra_path = ['_extra']
html_theme_options = { html_theme_options = {
"show_other_versions": True, "show_other_versions": True,
} }

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

@ -0,0 +1 @@
# No redirects in place yet.

1
tox.ini
View File

@ -50,6 +50,7 @@ deps =
commands = commands =
rm -rf doc/build rm -rf doc/build
sphinx-build -W --keep-going -b html doc/source doc/build/html 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] [testenv:deploy-guide]
deps = {[testenv:docs]deps} deps = {[testenv:docs]deps}