summaryrefslogtreecommitdiffstats
path: root/doc/conf.py.in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/conf.py.in')
-rw-r--r--doc/conf.py.in70
1 files changed, 34 insertions, 36 deletions
diff --git a/doc/conf.py.in b/doc/conf.py.in
index cf81c5d..4741de3 100644
--- a/doc/conf.py.in
+++ b/doc/conf.py.in
@@ -7,14 +7,12 @@ release = "@SUIL_VERSION@"
# General configuration
+exclude_patterns = ["xml"]
language = "en"
+nitpicky = True
+pygments_style = "friendly"
-extensions = [
- # 'sphinx_rtd_theme',
-]
-
-# Enable nitpicky mode to get warnings about broken links
-# Unfortunately this means we need to explicitly ignore everything external
+# Ignore everything opaque or external for nitpicky mode
nitpicky = True
_opaque = [
"LV2_Feature",
@@ -25,45 +23,45 @@ _opaque = [
nitpick_ignore = list(map(lambda x: ("c:identifier", x), _opaque))
-templates_path = ["_templates"]
-
-pygments_style = "friendly"
-
# HTML output
-exclude_patterns = ["xml"]
html_static_path = ["_static"]
+html_theme = "sphinx_lv2_theme"
+html_copy_source = False
+html_short_title = "Suil"
-html_theme = "alabaster"
-# html_theme = "sphinx_rtd_theme"
-
-if html_theme == "alabaster":
-
- html_theme_options = {
- "description": "A library for loading LV2 plugin UIs",
- "donate_url": "http://drobilla.net/pages/donate.html",
- # "github_repo": "suil",
- # "github_user": "lv2",
- # "logo": "suil.svg",
- "logo_name": True,
- "logo_text_align": "center",
- "page_width": "80em - 20em",
- "sidebar_width": "20em",
- }
-
+if tags.has("singlehtml"):
html_sidebars = {
"**": [
- "about.html",
- "localtoc.html",
- "donate.html",
+ "globaltoc.html",
]
}
-elif html_theme == "sphinx_rtd_theme":
+ html_theme_options = {
+ "body_max_width": "48em",
+ "body_min_width": "48em",
+ "description": "A library for loading LV2 plugin UIs",
+ "globaltoc_collapse": False,
+ "globaltoc_maxdepth": 3,
+ "logo_name": True,
+ "nosidebar": False,
+ "page_width": "80em",
+ "show_footer_version": True,
+ "show_logo_version": False,
+ "sidebar_width": "18em",
+ }
+else:
html_theme_options = {
- "sticky_navigation": False,
- "collapse_navigation": False,
- "navigation_depth": 4,
- "display_version": True,
+ "body_max_width": "60em",
+ "body_min_width": "40em",
+ "description": "A library for loading LV2 plugin UIs",
+ "globaltoc_collapse": True,
+ "globaltoc_maxdepth": 1,
+ "logo_name": True,
+ "nosidebar": True,
+ "page_width": "60em",
+ "show_footer_version": True,
+ "show_logo_version": False,
+ "sidebar_width": "14em",
}