Release v1.3.0

**Main Changes:**
- Add tanh function to ParamObj (#798)
- Upgrades to AnalogDevice specs (#807) 
- **Defining the new Backend API classes** (#764)
- **Documentation Upgrade** (#811)

.gitignore

@@ -13,6 +13,7 @@ _build
 __pycache__/
 build/
 docs/build/
+_autosummary/
 dist/
 env*
 *.egg-info/

.readthedocs.yml

@@ -8,7 +8,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.9"
+    python: "3.10"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

VERSION.txt

@@ -1 +1 @@
-1.2.2
+1.3.0

docs/requirements.txt

@@ -1,11 +1,10 @@
 # For generating documentation.
-Sphinx < 7
+Sphinx < 8
 sphinx-rtd-theme # documentation theme
-sphinx_autodoc_typehints == 1.21.3
+sphinx_autodoc_typehints == 2.2.1
 nbsphinx
 nbsphinx-link
 ipython >= 8.10 # Avoids bug with code highlighting
 myst-parser
-
 # Not on PyPI
 # pandoc

docs/source/_static/css/custom.css

@@ -0,0 +1,51 @@
+/* Limit content width, for large screens only */
+@media screen and (min-width: 1100px) {
+  .wy-nav-content {
+    width: 80% !important;
+    max-width: 1600px !important;
+  }
+}
+
+/* Apply Pasqal branding colors */
+.wy-nav-content-wrap {
+  background-color: #fcfcfc;
+}
+
+.wy-nav-top,
+.wy-nav-side {
+  background-color: #243237;
+}
+
+.wy-side-nav-search {
+  background-color: #00ac85;
+}
+
+.wy-side-nav-search a.icon {
+  font-size: 0px;
+  margin-bottom: 1rem;
+}
+
+.wy-side-nav-search a.icon img.logo {
+  max-width: 200px;
+}
+
+.wy-menu-vertical header,
+.wy-menu-vertical p.caption {
+  color: #00ac85;
+}
+
+.wy-menu-vertical a {
+  color: white;
+}
+
+.wy-menu-vertical a:hover {
+  background: #173035;
+}
+
+a {
+  color: #00ac85;
+}
+
+a:hover {
+  color: #00c887;
+}

docs/source/_templates/autosummary/class.rst

@@ -0,0 +1,37 @@
+{{ objname| escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :inherited-members:
+   :show-inheritance:
+   :member-order: groupwise
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+      :nosignatures:
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block methods %}
+   {% if methods and methods != ['__init__'] %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+      :nosignatures:
+   {% for item in methods %}
+      {%- if not item.startswith('_') or item in ['__call__'] %}
+         ~{{ name }}.{{ item }}
+      {%- endif -%}
+   {%- endfor %}
+
+   .. rubric:: {{ _('Signatures') }}
+   {% endif %}
+   {% endblock %}

docs/source/_templates/autosummary/function.rst

@@ -0,0 +1,5 @@
+{{ objname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autofunction:: {{ objname }}

docs/source/_templates/autosummary/module.rst

@@ -0,0 +1,44 @@
+{% extends "!autosummary/module.rst" %}
+
+{# This file is almost the same as the default, but adds :toctree: to the autosummary directives.
+   The original can be found at `sphinx/ext/autosummary/templates/autosummary/module.rst`. #}
+
+
+{% block functions %}
+{%- if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+      :toctree:
+
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+{% endif %}
+{%- endblock %}
+
+{% block classes %}
+{% if classes %}
+   .. rubric:: {{ _('Classes') }}
+   .. autosummary::
+      :toctree:
+      :nosignatures:
+
+   {% for item in classes %}
+      ~{{ fullname }}.{{ item }}
+   {%- endfor %}
+{% endif %}
+   {% endblock %}
+
+{%- block modules %}
+{#{%- if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}#}
+{%- endblock %}