diff options
| author | Tim Suhling <tim@suhling.com> | 2024-07-12 11:20:33 +0200 |
|---|---|---|
| committer | Tim Suhling <tim@suhling.com> | 2024-07-12 11:20:33 +0200 |
| commit | d384ff1da5c98a3c94e5ed59ae7496c2e64846b8 (patch) | |
| tree | 5c49838650af2e0c91334c816d6f41885067db42 /docs/conf.py | |
| parent | d6a1520bb5f8b74f966a79ff1c5b49c0931c34e1 (diff) | |
Set up documentation
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..e7dd896 --- /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
+
+from pathlib import Path
+import sys
+sys.path.insert(0, str(Path.cwd().parent/'schroedinger'))
+
+
+project = 'schroedinger'
+copyright = '2024, Thomas Albers Raviola, Tim Suhling'
+author = 'Thomas Albers Raviola, Tim Suhling'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.napoleon',
+ 'sphinx.ext.mathjax'
+]
+
+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 = 'sphinx_book_theme'
+html_static_path = ['_static']
|