aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst13
-rw-r--r--docs/conf.py69
-rw-r--r--docs/index.rst43
3 files changed, 64 insertions, 61 deletions
diff --git a/docs/api.rst b/docs/api.rst
index d3bfedf..b2e2786 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -1,6 +1,7 @@
-****************
-Schroedinger API
-****************
-
-.. automodule:: schroedinger
- :members:
+****************
+Schroedinger API
+****************
+
+
+.. automodule:: schroedinger
+ :members:
diff --git a/docs/conf.py b/docs/conf.py
index e7dd896..6f98975 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,34 +1,35 @@
-# 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']
+# 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']
diff --git a/docs/index.rst b/docs/index.rst
index acdfc79..e2efadb 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,21 +1,22 @@
-.. schroedinger documentation master file, created by
- sphinx-quickstart on Fri Jul 12 10:53:36 2024.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
-Welcome to schroedinger's documentation!
-========================================
-
-.. toctree::
- :maxdepth: 2
-
- api
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+.. schroedinger documentation master file, created by
+ sphinx-quickstart on Fri Jul 12 10:53:36 2024.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to schroedinger's documentation!
+========================================
+
+.. toctree::
+ :maxdepth: 2
+
+ api
+
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`