KonstantinSeurer
/
mesa
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add an extension to generate redirects 

Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/5706>
This commit is contained in:
Erik Faye-Lund 2020-07-02 12:14:28 +02:00 committed by Marge Bot
parent ce5a3524fa
commit 64a4ba9e1c
2 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/_exts/redirects.py Normal file
View File

@ -0,0 +1,19 @@
import os
redirects = []
def create_redirect(dst):
tpl = '<html><head><meta http-equiv="refresh" content="0; url={0}"><script>window.location.replace("{0}")</script></head></html>'
return tpl.format(dst)
def create_redirects(app, docname):
if not app.builder.name == 'html':
return
for src, dst in redirects:
path = os.path.join(app.outdir, '{0}.html'.format(src))
url = '{0}.html'.format(dst)
with open(path, 'w') as f:
f.write(create_redirect(url))
def setup(app):
app.connect('build-finished', create_redirects)

2
docs/conf.py
View File

@ -38,7 +38,7 @@ sys.path.append(os.path.abspath('_exts'))
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.graphviz', 'formatting']
extensions = ['sphinx.ext.graphviz', 'formatting', 'redirects']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']