summaryrefslogtreecommitdiffstats
path: root/share/extensions/docs/conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'share/extensions/docs/conf.py')
-rw-r--r--share/extensions/docs/conf.py93
1 files changed, 93 insertions, 0 deletions
diff --git a/share/extensions/docs/conf.py b/share/extensions/docs/conf.py
new file mode 100644
index 0000000..62e2884
--- /dev/null
+++ b/share/extensions/docs/conf.py
@@ -0,0 +1,93 @@
+# 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("../"))
+
+import datetime
+
+# -- Project information -----------------------------------------------------
+
+project = "inkex documentation"
+copyright = f"{datetime.datetime.now().year} The Inkscape Project"
+author = "The Inkscape Project"
+
+
+# -- 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.viewcode",
+ "sphinx.ext.todo",
+ "sphinx.ext.napoleon",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# 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 = "pydata_sphinx_theme"
+
+html_theme_options = {
+ "show_toc_level": 2,
+ "use_edit_page_button": True,
+ "gitlab_url": "https://gitlab.com/inkscape/extensions",
+}
+
+html_context = {
+ "gitlab_user": "inkscape",
+ "gitlab_repo": "extensions",
+ "gitlab_version": "master",
+ "doc_path": "docs",
+}
+
+# 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"]
+
+# -- Extension configuration -------------------------------------------------
+
+always_document_param_types = True
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+autodoc_member_order = "bysource"
+
+autodoc_preserve_defaults = True
+
+html_favicon = "favicon.svg"