Merge pull request #43 from qiboteam/docs

Documentation draft

doc/Makefile

@@ -0,0 +1,23 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+view: html
+	$(BROWSER) build/html/index.html

doc/source/_static/css/style.css

@@ -0,0 +1,7 @@
+.wy-side-nav-search {
+    background-color: #6400FF;
+}
+
+.wy-nav-top {
+    background-color: #6400FF;
+}

doc/source/api-reference/qiboml.backends.rst

@@ -0,0 +1,34 @@
+qiboml.backends package
+=======================
+
+.. automodule:: qiboml.backends
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+qiboml.backends.jax module
+--------------------------
+
+.. automodule:: qiboml.backends.jax
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+qiboml.backends.pytorch module
+------------------------------
+
+.. automodule:: qiboml.backends.pytorch
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+qiboml.backends.tensorflow module
+---------------------------------
+
+.. automodule:: qiboml.backends.tensorflow
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/source/api-reference/qiboml.rst

@@ -0,0 +1,15 @@
+qiboml package
+==============
+
+.. automodule:: qiboml
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   qiboml.backends