Added documentation

- Using sphinx to documente the project - Autodocumenting Python using numpy-style docstr and sphinx autodoc with napoleon
2024-06-03 20:29:28 +02:00
parent f0ce32250a
commit c22049f499
40 changed files with 1303 additions and 26 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,7 @@
 # ---> Python
 # Byte-compiled / optimized / DLL files
 __pycache__/
+*/__pycache__/
 *.py[cod]
 *$py.class

@@ -10,6 +11,7 @@ __pycache__/
 # Distribution / packaging
 .Python
 build/
+docs/build
 develop-eggs/
 dist/
 downloads/