1# Project information
2
3project = "Pugl"
4copyright = "2020, David Robillard"
5author = "David Robillard"
6release = "@PUGL_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    "PFN_vkGetDeviceProcAddr",
18    "PFN_vkGetInstanceProcAddr",
19    "PuglBackendImpl",
20    "PuglViewImpl",
21    "PuglVulkanLoaderImpl",
22    "PuglWorldImpl",
23    "VkAllocationCallbacks",
24    "VkInstance",
25    "VkResult",
26    "VkSurfaceKHR",
27    "size_t",
28    "uint32_t",
29    "uintptr_t",
30]
31
32_c_nitpick_ignore = map(lambda x: ("c:identifier", x), _opaque)
33_cpp_nitpick_ignore = map(lambda x: ("cpp:identifier", x), _opaque)
34nitpick_ignore = list(_c_nitpick_ignore) + list(_cpp_nitpick_ignore)
35
36# C++
37
38cpp_index_common_prefix = ["pugl::"]
39
40# HTML output
41
42html_copy_source = False
43html_short_title = "Pugl"
44html_static_path = ["../_static"]
45html_theme = "sphinx_lv2_theme"
46
47if tags.has('singlehtml'):
48    html_sidebars = {
49        "**": [
50        "globaltoc.html",
51        ]
52    }
53
54    html_theme_options = {
55        "body_max_width": "51em",
56        "body_min_width": "51em",
57        "description": "A minimal portable API for embeddable GUIs.",
58        "show_footer_version": True,
59        "show_logo_version": False,
60        "logo": "pugl.svg",
61        "logo_name": True,
62        "logo_width": "8em",
63        "nosidebar": False,
64        "page_width": "80em",
65        "sidebar_width": "16em",
66        "globaltoc_maxdepth": 3,
67        "globaltoc_collapse": False,
68    }
69
70else:
71    html_theme_options = {
72        "body_max_width": "60em",
73        "body_min_width": "40em",
74        "description": "A minimal portable API for embeddable GUIs.",
75        "show_footer_version": True,
76        "show_logo_version": False,
77        "logo": "pugl.svg",
78        "logo_name": True,
79        "logo_width": "8em",
80        "nosidebar": True,
81        "page_width": "60em",
82        "sidebar_width": "14em",
83        "globaltoc_maxdepth": 1,
84        "globaltoc_collapse": True,
85    }
86