aboutsummaryrefslogtreecommitdiff
path: root/docs/source/_extensions/redirects.py
blob: 6a59b622d03567eceb776f0251137971becb2a47 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
import os

# https://tech.signavio.com/2017/managing-sphinx-redirects


template="""<html>
  <head>
    <meta http-equiv="refresh" content="1; url=%s" />
    <script>
      window.location.href = "%s"
    </script>
  </head>
</html>"""


def gather_redirects():
    output = {}

    output.update({ 'projjson.html' : 'usage/projjson.html' })
    return output

from shutil import copyfile
# copy legacy redirects
def copy_legacy_redirects(app, docname): # Sphinx expects two arguments
    if app.builder.name == 'html':
        for key in app.config.redirect_files:
            src = key
            tgt = app.config.redirect_files[key]
            html = template % (tgt, tgt)
            with open(os.path.join(app.outdir, src), 'wb') as f:
                f.write(html.encode('utf-8'))
                f.close()



def setup(app):
    app.add_config_value('redirect_files', {}, 'html')
    app.connect('build-finished', copy_legacy_redirects)
    return { 'parallel_read_safe': False, 'parallel_write_safe': True }