1# Project information
2
3project = "Sratom"
4copyright = "2020, David Robillard"
5author = "David Robillard"
6release = "@SRATOM_VERSION@"
7
8# General configuration
9
10exclude_patterns = ["xml"]
11language = "en"
12nitpicky = True
13pygments_style = "friendly"
14
15# Ignore everything opaque or external for nitpicky mode
16_opaque = [
17    "LV2_Atom",
18    "LV2_Atom_Forge",
19    "LV2_Atom_Forge_Ref",
20    "LV2_Atom_Forge_Sink_Handle",
21    "LV2_URID_Map",
22    "LV2_URID_Unmap",
23    "SerdEndSink",
24    "SerdEnv",
25    "SerdNode",
26    "SerdStatementSink",
27    "SordModel",
28    "SordNode",
29    "SordWorld",
30    "SratomImpl",
31    "uint32_t",
32]
33
34nitpick_ignore = list(map(lambda x: ("c:identifier", x), _opaque))
35
36# HTML output
37
38html_theme = "sphinx_lv2_theme"
39html_copy_source = False
40html_short_title = "Sratom"
41
42if tags.has("singlehtml"):
43    html_sidebars = {
44        "**": [
45            "globaltoc.html",
46        ]
47    }
48
49    html_theme_options = {
50        "body_max_width": "48em",
51        "body_min_width": "48em",
52        "description": "A small library for serialising LV2 atoms to and from RDF",
53        "globaltoc_collapse": False,
54        "globaltoc_maxdepth": 3,
55        "logo_name": True,
56        "nosidebar": False,
57        "page_width": "80em",
58        "show_footer_version": True,
59        "show_logo_version": False,
60        "sidebar_width": "18em",
61    }
62
63else:
64    html_theme_options = {
65        "body_max_width": "60em",
66        "body_min_width": "40em",
67        "description": "A small library for serialising LV2 atoms to and from RDF",
68        "globaltoc_collapse": True,
69        "globaltoc_maxdepth": 1,
70        "logo_name": True,
71        "nosidebar": True,
72        "page_width": "60em",
73        "show_footer_version": True,
74        "show_logo_version": False,
75        "sidebar_width": "14em",
76    }
77