Generate documentation with Sphinx and add an overview

1 files changed, 79 insertions, 0 deletions

diff --git a/doc/conf.py.in b/doc/conf.py.in
new file mode 100644
index 0000000..e62eaff
--- /dev/null
+++ b/doc/conf.py.in
@@ -0,0 +1,79 @@
+# Project information
+
+project = "Lilv"
+copyright = "2020, David Robillard"
+author = "David Robillard"
+release = "@LILV_VERSION@"
+
+# General configuration
+
+exclude_patterns = ["xml"]
+language = "en"
+nitpicky = True
+pygments_style = "friendly"
+
+# Ignore everything opaque or external for nitpicky mode
+_opaque = [
+    "FILE",
+    "LV2_Descriptor",
+    "LV2_Feature",
+    "LV2_Handle",
+    "LV2_URID_Map",
+    "LV2_URID_Unmap",
+    "LilvInstanceImpl",
+    "LilvNodeImpl",
+    "LilvPluginClassImpl",
+    "LilvPluginImpl",
+    "LilvPortImpl",
+    "LilvScalePointImpl",
+    "LilvStateImpl",
+    "LilvUIImpl",
+    "LilvWorldImpl",
+    "size_t",
+    "uint32_t",
+    "va_list",
+]
+
+nitpick_ignore = list(map(lambda x: ("c:identifier", x), _opaque))
+
+# HTML output
+
+html_theme = "sphinx_lv2_theme"
+html_copy_source = False
+html_short_title = "Lilv"
+
+if tags.has('singlehtml'):
+    html_sidebars = {
+        "**": [
+        "globaltoc.html",
+        ]
+    }
+
+    html_theme_options = {
+        "body_max_width": "65em",
+        "body_min_width": "50em",
+        "description": "A library for loading LV2 plugins",
+        "show_footer_version": True,
+        "show_logo_version": False,
+        "logo_name": True,
+        "nosidebar": False,
+        "page_width": "80em",
+        "sidebar_width": "11em",
+        "globaltoc_maxdepth": 3,
+        "globaltoc_collapse": False,
+    }
+
+else:
+    html_theme_options = {
+        "body_max_width": "60em",
+        "body_min_width": "40em",
+        "description": "A library for loading LV2 plugins",
+        "show_footer_version": True,
+        "show_logo_version": False,
+        "logo_name": True,
+        "nosidebar": True,
+        "page_width": "60em",
+        "sidebar_width": "14em",
+        "globaltoc_maxdepth": 1,
+        "globaltoc_collapse": True,
+    }