From 6b16f20e5c965406b841790ca0d7ae56925860ac Mon Sep 17 00:00:00 2001 From: Nao Pross Date: Mon, 29 Apr 2024 14:12:22 +0200 Subject: Add sphinx documentation generator To generate the documentation run $ make -C docs html --- docs/conf.py | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 docs/conf.py (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..2e293f4 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,34 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +# Add path of polymatrix code +import os +import sys +sys.path.insert(0, os.path.abspath("..")) + +project = 'polymatrix' +copyright = '2024, Michael Schneeberger' +author = 'Michael Schneeberger' +release = '0.0.1' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary'] +autosummary_generate = True + +templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'python_docs_theme' +html_static_path = ['_static'] -- cgit v1.2.1