aboutsummaryrefslogtreecommitdiff
path: root/subprojects/d2tk/pugl/doc/conf.py.in
blob: 3fa8ea215ad0d42707f50b19f87f98d7af994aa7 (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
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
85
# Project information

project = "Pugl"
copyright = "2020, David Robillard"
author = "David Robillard"
release = "@PUGL_VERSION@"

# General configuration

exclude_patterns = ["xml"]
language = "en"
nitpicky = True
pygments_style = "friendly"

# Ignore everything opaque or external for nitpicky mode
_opaque = [
    "PFN_vkGetDeviceProcAddr",
    "PFN_vkGetInstanceProcAddr",
    "PuglBackendImpl",
    "PuglViewImpl",
    "PuglVulkanLoaderImpl",
    "PuglWorldImpl",
    "VkAllocationCallbacks",
    "VkInstance",
    "VkResult",
    "VkSurfaceKHR",
    "size_t",
    "uint32_t",
    "uintptr_t",
]

_c_nitpick_ignore = map(lambda x: ("c:identifier", x), _opaque)
_cpp_nitpick_ignore = map(lambda x: ("cpp:identifier", x), _opaque)
nitpick_ignore = list(_c_nitpick_ignore) + list(_cpp_nitpick_ignore)

# C++

cpp_index_common_prefix = ["pugl::"]

# HTML output

html_copy_source = False
html_short_title = "Pugl"
html_static_path = ["../_static"]
html_theme = "sphinx_lv2_theme"

if tags.has('singlehtml'):
    html_sidebars = {
        "**": [
        "globaltoc.html",
        ]
    }

    html_theme_options = {
        "body_max_width": "51em",
        "body_min_width": "51em",
        "description": "A minimal portable API for embeddable GUIs.",
        "show_footer_version": True,
        "show_logo_version": False,
        "logo": "pugl.svg",
        "logo_name": True,
        "logo_width": "8em",
        "nosidebar": False,
        "page_width": "80em",
        "sidebar_width": "16em",
        "globaltoc_maxdepth": 3,
        "globaltoc_collapse": False,
    }

else:
    html_theme_options = {
        "body_max_width": "60em",
        "body_min_width": "40em",
        "description": "A minimal portable API for embeddable GUIs.",
        "show_footer_version": True,
        "show_logo_version": False,
        "logo": "pugl.svg",
        "logo_name": True,
        "logo_width": "8em",
        "nosidebar": True,
        "page_width": "60em",
        "sidebar_width": "14em",
        "globaltoc_maxdepth": 1,
        "globaltoc_collapse": True,
    }