From fc65f07fb1ac86466dab7ad8437ec07a8010a275 Mon Sep 17 00:00:00 2001 From: Thomas Albers Raviola Date: Fri, 12 Jul 2024 11:36:04 +0200 Subject: Normalize line endings --- .gitignore | 7 +++-- README.md | 1 + docs/api.rst | 13 +++++---- docs/conf.py | 69 ++++++++++++++++++++++---------------------- docs/index.rst | 43 +++++++++++++-------------- schroedinger/schroedinger.py | 32 ++++++++++---------- 6 files changed, 86 insertions(+), 79 deletions(-) diff --git a/.gitignore b/.gitignore index 93ab237..7c43785 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ -docs/_build -.idea/ -schroedinger/__pycache__ +docs/_build +.idea/ + +schroedinger/__pycache__ diff --git a/README.md b/README.md index e69de29..ce01362 100644 --- a/README.md +++ b/README.md @@ -0,0 +1 @@ +hello 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` diff --git a/schroedinger/schroedinger.py b/schroedinger/schroedinger.py index c13a881..63ea5f8 100644 --- a/schroedinger/schroedinger.py +++ b/schroedinger/schroedinger.py @@ -1,15 +1,17 @@ - -def hello(): - """ - This is a description :) - :return: None - """ - print('Hello') - - -def main(): - hello() - - -if __name__ == "__main__": - main() + +def hello(): + """ + This is a description :) + :return: None + """ + print('Hello') + + +def main(): + hello() + + + +if __name__ == "__main__": + + main() -- cgit v1.2.3