- Notifications
You must be signed in to change notification settings - Fork 15
/
Copy pathconf.py
73 lines (47 loc) · 2.46 KB
/
conf.py
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
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
fromdatetimeimportdate
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project='sip'
copyright='{0} Phil Thompson <phil@riverbankcomputing.com>'.format(
date.today().year)
author='Phil Thompson'
version='v6.10.0'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions= ['myst_parser', 'sphinx.ext.intersphinx']
intersphinx_mapping= {'python': ('https://docs.python.org/3', None)}
#templates_path = ['_templates']
exclude_patterns= ['_build', 'Thumbs.db', '.DS_Store']
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme='sphinx_rtd_theme'
#html_static_path = ['_static']
# MyST configuration
myst_enable_extensions= {'deflist'}
# -- Project-specific extensions -----------------------------------------------
defsetup(app):
""" Define roles specific to SIP. """
app.add_object_type('argument-annotation', 'aanno',
indextemplate='single: %s (argument annotation)')
app.add_object_type('class-annotation', 'canno',
indextemplate='single: %s (class annotation)')
app.add_object_type('enum-annotation', 'eanno',
indextemplate='single: %s (enum annotation)')
app.add_object_type('exception-annotation', 'xanno',
indextemplate='single: %s (exception annotation)')
app.add_object_type('function-annotation', 'fanno',
indextemplate='single: %s (function annotation)')
app.add_object_type('mapped-type-annotation', 'manno',
indextemplate='single: %s (mapped type annotation)')
app.add_object_type('typedef-annotation', 'tanno',
indextemplate='single: %s (typedef annotation)')
app.add_object_type('variable-annotation', 'vanno',
indextemplate='single: %s (variable annotation)')
app.add_object_type('sip-type', 'stype',
indextemplate='single: %s (SIP type)')
app.add_crossref_type('directive', 'directive',
indextemplate='single: %s (directive)')
