aboutsummaryrefslogtreecommitdiff
path: root/subprojects/d2tk/pugl/doc/conf.py.in
blob: 9ca7bfae7944b789283b76486d652729cc9a5d8d (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
86
87
88
# Project information

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

# General configuration

language = "en"

extensions = [
    # 'breathe',
    # 'sphinx_rtd_theme',
    # 'sphinx.ext.autodoc',
    # 'sphinx.ext.doctest',
    # 'sphinx.ext.napoleon',
    # 'sphinx.ext.viewcode',
]

# Enable nitpicky mode to get warnings about broken links
# Unfortunately this means we need to explicitly ignore everything external
nitpicky = True
_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)

templates_path = ["_templates"]

pygments_style = "friendly"

# C++

cpp_index_common_prefix = ["pugl::"]

# HTML output

exclude_patterns = ["xml"]
html_static_path = ["_static"]

html_theme = "alabaster"
# html_theme = "sphinx_rtd_theme"

if html_theme == "alabaster":

    html_theme_options = {
        "description": "A minimal portable API for embeddable GUIs.",
        "donate_url": "http://drobilla.net/pages/donate.html",
        # "github_repo": "pugl",
        # "github_user": "lv2",
        "logo": "pugl.svg",
        "logo_name": True,
        "logo_text_align": "center",
        "page_width": "80em - 20em",
        "sidebar_width": "20em",
    }

    html_sidebars = {
        "**": [
            "about.html",
            "localtoc.html",
            "donate.html",
        ]
    }

elif html_theme == "sphinx_rtd_theme":

    html_theme_options = {
        "sticky_navigation": False,
        "collapse_navigation": False,
        "navigation_depth": 4,
        "display_version": True,
    }