Add first sphinx build (manual)

marco-2023 · Apr 7, 2022 · e893b62 · e893b62
1 parent f03879f
commit e893b62
Show file tree

Hide file tree

Showing 46 changed files with 18,445 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -7,8 +7,8 @@ __pycache__/
 *.so
 
 # Distribution / packaging
+/build/
 .Python
-build/
 develop-eggs/
 dist/
 downloads/

diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 6eead75345ae0dc3a7dc35c0c4220429
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
@@ -0,0 +1,37 @@
+.. MoHa documentation master file, created by
+   sphinx-quickstart on Tue Apr  5 14:47:24 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+MoHa: Model Hamiltonians
+========================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+Hamiltonian API
+===============
+
+.. autoclass:: moha.api.HamiltonianAPI
+    :members:
+
+Model Hamiltonians
+==================
+
+.. autoclass:: moha.HamPPP
+    :members:
+
+.. autoclass:: moha.HamHub
+    :members:
+
+.. autoclass:: moha.HamHuck
+    :members:
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,8 +7,8 @@ __pycache__/ @@
     *.so
     # Distribution / packaging
+    /build/
     .Python
-    build/
     develop-eggs/
     dist/
     downloads/
@@ Expand Down @@