Merge branch 'docs' into readme

unitaryfund · Jun 13, 2024 · 171e54e · 171e54e
2 parents a798b66 + d46d8f0
commit 171e54e
Show file tree

Hide file tree

Showing 15 changed files with 590 additions and 0 deletions.
diff --git a/doc/Makefile b/doc/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python3 -msphinx
+SPHINXPROJ    = PennyLane-Qrack
+SOURCEDIR     = .
+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)
diff --git a/doc/_static/favicon.ico b/doc/_static/favicon.ico
diff --git a/doc/_static/logo.png b/doc/_static/logo.png
diff --git a/doc/_static/logo_new.png b/doc/_static/logo_new.png
diff --git a/doc/_static/pennylane.png b/doc/_static/pennylane.png
diff --git a/doc/_static/pennylane.svg b/doc/_static/pennylane.svg
diff --git a/doc/_static/puzzle_qulacs.png b/doc/_static/puzzle_qulacs.png
diff --git a/doc/_static/xanadu_x.png b/doc/_static/xanadu_x.png
diff --git a/doc/code.rst b/doc/code.rst
@@ -0,0 +1,18 @@
+pennylane-qrack
+===============
+
+This section contains the API documentation for the PennyLane-Qrack plugin.
+
+.. warning::
+
+    Unless you are a PennyLane plugin developer, you likely do not need
+    to use these classes and functions directly.
+
+    See the :doc:`overview </index>` page for more
+    details using the available Qrack devices with PennyLane.
+
+.. currentmodule:: pennylane_qrack
+
+.. automodapi:: pennylane_qrack
+    :no-heading:
+    :include-all-objects: