Merge pull request #14 from unitaryfund/docs

Docs (adapted from Qulacs)
unitaryfund · Jun 20, 2024 · f942b2f · f942b2f
2 parents fa3779b + 89cd7cb
commit f942b2f
Show file tree

Hide file tree

Showing 22 changed files with 642 additions and 98 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt
diff --git a/.github/workflows/post_release_version_bump.yml b/.github/workflows/post_release_version_bump.yml
diff --git a/.github/workflows/pre_release_version_bump.yml b/.github/workflows/pre_release_version_bump.yml
diff --git a/.github/workflows/upload.yml b/.github/workflows/upload.yml
diff --git a/README.rst b/README.rst
@@ -15,6 +15,8 @@ Features
 * Provides access to a PyQrack simulator backend via the ``qrack.simulator`` device
 * Provides access to a (C++) Qrack simulator backend for Catalyst (also) via the ``qrack.simulator`` device
 
+.. installation-start-inclusion-marker-do-not-remove
+
 Installation
 ============
 
@@ -57,6 +59,7 @@ If you currently do not have Python 3 installed, we recommend
 `Anaconda for Python 3 <https://www.anaconda.com/download/>`__, a distributed version of Python packaged
 for scientific computation.
 
+.. installation-end-inclusion-marker-do-not-remove
 
 Tests
 ~~~~~

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-Qulacs
+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: