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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
# Configuration file for Sphinx,
# see https://www.sphinx-doc.org/en/master/usage/configuration.html
from subprocess import check_output
# -- General configuration -----------------------------------------------------
extensions = [
# 'sphinx_last_updated_by_git',
]
master_doc = 'index'
project = u'SoundScape Renderer'
copyright = u'2023, SSR Team'
try:
release = check_output(['git', 'describe', '--tags', '--always'])
release = release.decode().strip()
except Exception:
release = '<unknown>'
language = 'en'
try:
today = check_output(['git', 'show', '-s', '--format=%ad', '--date=short'])
today = today.decode().strip()
except Exception:
today = '<unknown date>'
exclude_patterns = ['_build']
highlight_language = 'sh'
linkcheck_ignore = [
r'http://localhost:\d+',
]
# -- Options for HTML output ---------------------------------------------------
html_theme = 'sphinx_rtd_theme'
html_favicon = 'favicon.svg'
html_domain_indices = False
html_use_index = False
html_show_copyright = False
html_copy_source = False
html_permalinks_icon = '#'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
'babel': '\\usepackage[english]{babel}',
#'preamble': '',
}
latex_documents = [
('index', 'SoundScapeRenderer.tex', project, u'SSR Team', 'manual'),
]
def assemble_link_role(github_url, text):
from docutils import nodes, utils
blob_url = github_url + '/blob/master'
base_url = blob_url + '/%s'
text = utils.unescape(text)
full_url = base_url % text
pnode = nodes.reference(internal=False, refuri=full_url)
pnode += nodes.literal(text, text, classes=['file'])
return pnode
def gh_link_ssr_role(rolename, rawtext, text, lineno, inliner,
options={}, content=()):
pnode = assemble_link_role('https://github.com/SoundScapeRenderer/ssr',
text)
return [pnode], []
def gh_link_es_role(rolename, rawtext, text, lineno, inliner,
options={}, content=()):
pnode = assemble_link_role(
'https://github.com/SoundScapeRenderer/example-scenes', text)
return [pnode], []
def setup(app):
app.add_role('gh-link-ssr', gh_link_ssr_role)
app.add_role('gh-link-es', gh_link_es_role)
|
