Generate documentation with Sphinx

1 files changed, 80 insertions, 0 deletions

diff --git a/doc/conf.py.in b/doc/conf.py.in
new file mode 100644
index 0000000..2b1c485
--- /dev/null
+++ b/doc/conf.py.in
@@ -0,0 +1,80 @@
+# Project information
+
+project = "Sratom"
+copyright = "2020, David Robillard"
+author = "David Robillard"
+release = "@SRATOM_VERSION@"
+
+# General configuration
+
+language = "en"
+
+extensions = [
+    # 'sphinx_rtd_theme',
+]
+
+# Enable nitpicky mode to get warnings about broken links
+# Unfortunately this means we need to explicitly ignore everything external
+nitpicky = True
+_opaque = [
+    "LV2_Atom",
+    "LV2_Atom_Forge",
+    "LV2_Atom_Forge_Ref",
+    "LV2_Atom_Forge_Sink_Handle",
+    "LV2_URID_Map",
+    "LV2_URID_Unmap",
+    "SerdEndSink",
+    "SerdEnv",
+    "SerdNode",
+    "SerdStatementSink",
+    "SordModel",
+    "SordNode",
+    "SordWorld",
+    "SratomImpl",
+    "uint32_t",
+]
+
+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 = "alabaster"
+# html_theme = "sphinx_rtd_theme"
+
+if html_theme == "alabaster":
+
+    html_theme_options = {
+        "description": "A small library for serialising LV2 atoms to and from RDF",
+        "donate_url": "http://drobilla.net/pages/donate.html",
+        # "github_repo": "sratom",
+        # "github_user": "lv2",
+        # "logo": "sratom.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,
+    }