TeamGraphix · shinich1 · Nov 5, 2023 · Oct 10, 2023 · Oct 10, 2023 · Oct 15, 2023
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -6,6 +6,9 @@ name: pytest
 on:
   pull_request:
     branches: [ "master" ]
+  schedule:
+    # Every Monday at 0AM UTC
+    - cron: "0 0 * * 1"
 
 permissions:
   contents: read

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,20 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+sphinx:
+   configuration: docs/source/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Graphix Perceval interface
-<!--
+
 ![PyPI](https://img.shields.io/pypi/v/graphix-perceval)
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/graphix-perceval) -->
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/graphix-perceval)
 
 Provides an interface to run MBQC pattern (`graphix.Pattern`) on Quandela's optical quantum devices as well as Perceval's simulator backends.
 
@@ -22,4 +22,4 @@ install with `pip`
 
 ## License
 
-[Apache License 2.0](LICENSE)
+[Apache License 2.0](LICENSE)
diff --git a/docs/logo/black_with_name.png b/docs/logo/black_with_name.png
diff --git a/docs/logo/black_with_text.png b/docs/logo/black_with_text.png
diff --git a/docs/logo/graphix-logo.pptx b/docs/logo/graphix-logo.pptx
diff --git a/docs/logo/white.png b/docs/logo/white.png
diff --git a/docs/logo/white_with_text.png b/docs/logo/white_with_text.png
diff --git a/docs/source/_static/img/ghz_circuit.svg b/docs/source/_static/img/ghz_circuit.svg
diff --git a/docs/source/_static/img/ghz_pattern.png b/docs/source/_static/img/ghz_pattern.png
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,62 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+import os
+import sys
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "graphix-perceval"
+copyright = "2023, Team Graphix"
+author = "Kazuki Tsuoka, Shinichi Sunami"
+release = "0.0.1"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.napoleon",
+    "sphinx_gallery.gen_gallery",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+autosectionlabel_prefix_document = True
+
+
+sys.path.insert(0, os.path.abspath("../.."))
+
+
+def skip(app, what, name, obj, would_skip, options):
+    if name == "__init__":
+        return False
+    return would_skip
+
+
+def setup(app):
+    app.connect("autodoc-skip-member", skip)
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
+html_logo = "../logo/white_with_text.png"
+html_theme_options = {
+    "logo_only": True,
+    "display_version": False,
+}
+
+sphinx_gallery_conf = {
+    "examples_dirs": "../../examples",  # path to your example scripts
+    "gallery_dirs": "gallery",  # path to where to save gallery generated output
+    "filename_pattern": "/",
+}
diff --git a/docs/source/converter.rst b/docs/source/converter.rst
@@ -0,0 +1,11 @@
+Pattern converter
+==================
+
+:mod:`graphix_perceval.converter` module
++++++++++++++++++++++++++++++++++++++++++
+
+.. automodule:: graphix_perceval.converter
+    :members:
+
+.. autoclass:: PercevalCircuitConstructor
+    :members:
diff --git a/docs/source/experiment.rst b/docs/source/experiment.rst
@@ -0,0 +1,16 @@
+Device interface
+================
+
+:mod:`graphix_perceval.experiment` module
++++++++++++++++++++++++++++++++++++++++++
+
+.. automodule:: graphix_perceval.experiment
+
+.. autoclass:: PercevalExperiment
+    :members:
+
+.. autoclass:: PhotonCount
+    :members:
+
+.. autoclass:: PhotonDistribution
+    :members:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,13 @@
+.. graphix-perceval documentation master file, created by
+   sphinx-quickstart on Mon Oct 16 05:34:14 2023.
+
+Graphix-perceval - executing MBQC patterns on Perceval devices
+==============================================================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Documentation
+
+   tutorial
+   gallery/index
+   reference
diff --git a/docs/source/reference.rst b/docs/source/reference.rst
@@ -0,0 +1,8 @@
+Module reference
+================
+
+.. toctree::
+   :maxdepth: 2
+
+   converter
+   experiment