diff options
author | Nao Pross <np@0hm.ch> | 2024-04-29 14:12:22 +0200 |
---|---|---|
committer | Nao Pross <np@0hm.ch> | 2024-04-29 14:12:22 +0200 |
commit | 6b16f20e5c965406b841790ca0d7ae56925860ac (patch) | |
tree | 01bed1c72b1fcaa9fd0a65f36a233de6febbcdf7 /docs/conf.py | |
parent | Add total order to MonomialIndex (diff) | |
download | polymatrix-6b16f20e5c965406b841790ca0d7ae56925860ac.tar.gz polymatrix-6b16f20e5c965406b841790ca0d7ae56925860ac.zip |
Add sphinx documentation generator
To generate the documentation run
$ make -C docs html
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 34 |
1 files changed, 34 insertions, 0 deletions
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'] |