1# Project information
2
3project = "Pugl"
4copyright = "2020, David Robillard"
5author = "David Robillard"
6release = "@PUGL_VERSION@"
7
8# General configuration
9
10language = "en"
11
12extensions = [
13    # 'breathe',
14    # 'sphinx_rtd_theme',
15    # 'sphinx.ext.autodoc',
16    # 'sphinx.ext.doctest',
17    # 'sphinx.ext.napoleon',
18    # 'sphinx.ext.viewcode',
19]
20
21# Enable nitpicky mode to get warnings about broken links
22# Unfortunately this means we need to explicitly ignore everything external
23nitpicky = True
24_opaque = [
25    "PFN_vkGetDeviceProcAddr",
26    "PFN_vkGetInstanceProcAddr",
27    "PuglBackendImpl",
28    "PuglViewImpl",
29    "PuglVulkanLoaderImpl",
30    "PuglWorldImpl",
31    "VkAllocationCallbacks",
32    "VkInstance",
33    "VkResult",
34    "VkSurfaceKHR",
35    "size_t",
36    "uint32_t",
37    "uintptr_t",
38]
39_c_nitpick_ignore = map(lambda x: ("c:identifier", x), _opaque)
40_cpp_nitpick_ignore = map(lambda x: ("cpp:identifier", x), _opaque)
41nitpick_ignore = list(_c_nitpick_ignore) + list(_cpp_nitpick_ignore)
42
43templates_path = ["_templates"]
44
45pygments_style = "friendly"
46
47# C++
48
49cpp_index_common_prefix = ["pugl::"]
50
51# HTML output
52
53exclude_patterns = ["xml"]
54html_static_path = ["_static"]
55
56html_theme = "alabaster"
57# html_theme = "sphinx_rtd_theme"
58
59if html_theme == "alabaster":
60
61    html_theme_options = {
62        "description": "A minimal portable API for embeddable GUIs.",
63        "donate_url": "http://drobilla.net/pages/donate.html",
64        # "github_repo": "pugl",
65        # "github_user": "lv2",
66        "logo": "pugl.svg",
67        "logo_name": True,
68        "logo_text_align": "center",
69        "page_width": "80em - 20em",
70        "sidebar_width": "20em",
71    }
72
73    html_sidebars = {
74        "**": [
75            "about.html",
76            "localtoc.html",
77            "donate.html",
78        ]
79    }
80
81elif html_theme == "sphinx_rtd_theme":
82
83    html_theme_options = {
84        "sticky_navigation": False,
85        "collapse_navigation": False,
86        "navigation_depth": 4,
87        "display_version": True,
88    }
89