aboutsummaryrefslogtreecommitdiffstats
path: root/bindings/python/conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'bindings/python/conf.py')
-rw-r--r--bindings/python/conf.py91
1 files changed, 91 insertions, 0 deletions
diff --git a/bindings/python/conf.py b/bindings/python/conf.py
new file mode 100644
index 00000000..3f9acac1
--- /dev/null
+++ b/bindings/python/conf.py
@@ -0,0 +1,91 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../../build/bindings/python'))
+
+
+
+from unittest.mock import Mock as MagicMock
+
+class Mock(MagicMock):
+ @classmethod
+ def __getattr__(cls, name):
+ return MagicMock()
+
+MOCK_MODULES = ['cython', 'libc.stdint']
+sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Serd'
+copyright = '2020, David Robillard'
+author = 'David Robillard'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.doctest',
+ 'sphinx.ext.napoleon',
+ 'sphinx.ext.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+html_theme_options = {'body_max_width': '80em'}
+
+html_sidebars = {
+ '**': [
+ 'about.html',
+ 'localtoc.html',
+ 'donate.html',
+ ]
+}
+
+html_theme_options = {
+ 'description': 'A lightweight library for working with RDF data.',
+ 'donate_url': 'http://drobilla.net/pages/donate.html',
+ 'github_repo': 'serd',
+ 'github_user': 'drobilla',
+ 'logo': 'serd.svg',
+ 'logo_name': True,
+ 'logo_text_align': 'center',
+ 'page_width': '80em - 15em',
+ 'sidebar_width': '15em',
+}