labscript-utils 3.3.0rc1__tar.gz → 3.4.0__tar.gz

labscript_utils-3.4.0/.github/workflows/release-vars.sh

@@ -0,0 +1,47 @@
+# This repository. PyPI and Anaconda test and release package uploads are only done if
+# the repository the workflow is running in matches this (i.e. is not a fork). Optional,
+# if not set, package uploads are skipped.
+export RELEASE_REPO="labscript-suite/labscript-utils"
+
+# Username with which to upload conda packages. If not given, anaconda uploads are
+# skipped.
+export ANACONDA_USER="labscript-suite"
+
+# Whether (true or false) to upload releases to PyPI, non-releases to Test PyPI,
+# releases to Anaconda, non-releases to Anaconda test label. Only used if the repository
+# the workflow is running in matches RELEASE_REPO, otherwise uploads are skipped.
+# Anaconda uploads require ANACONDA_USER be specified and ANACONDA_API_TOKEN secret be
+# set. Optional, all default to true.
+export PYPI_UPLOAD=""
+export TESTPYPI_UPLOAD=""
+export ANACONDA_UPLOAD=""
+export TEST_ANACONDA_UPLOAD=""
+
+# Which Python version to use for pure wheel builds, sdists, and as the host Python for
+# cibuildwheel. Optional, defaults to the second-most recent minor Python version.
+export DEFAULT_PYTHON=""
+
+# Comma-separated list of Python versions to build conda packages for. Only used if
+# HAS_ENV_MARKERS=true or PURE=false, otherwise a noarch conda package is built instead.
+# Optional, defaults to all non-end-of-life stable Python minor versions.
+export CONDA_PYTHONS=""
+
+# Environment variable set in the envionment that `cibuildwheel` runs in instructing it
+# which Pythons to build for, as a space-separated list of specifiers in the format
+# specified by `cibuildwheel`. Only used if PURE=false. Optional, defaults to all
+# non-end-of-life stable CPython versions.
+export CIBW_BUILD=""
+
+# Name of Python package. Optional, defaults to name from the package metadata
+export PKGNAME=""
+
+# Version of Python package. Optional, defaults to version from the package metadata
+export PKGVER=""
+
+# Whether the Python package is pure (true) or impure (false). Optional, defaults to
+# false if the setuptools package has extension modules or libraries, otherwise true.
+export PURE=""
+
+# Whether (true or false) the Python package has dependencies that vary by platform or
+# Python version. Optional, Defaults to presence of env markers in package metadata.
+export HAS_ENV_MARKERS=""

labscript_utils-3.4.0/.github/workflows/release.yml

@@ -0,0 +1,447 @@
+name: Build and Release
+
+on:
+  push:
+    branches:
+      - master
+      - maintenance/*
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+*'
+
+env:
+  OS_LIST_UBUNTU: '["ubuntu-latest"]'
+  OS_LIST_ALL: '["ubuntu-latest", "windows-latest", "macos-latest", "macos-13"]'
+
+
+jobs:
+  configure:
+    name: Configure workflow run
+    runs-on: ubuntu-latest
+    outputs:
+      DEFAULT_PYTHON: ${{ steps.config.outputs.DEFAULT_PYTHON }}
+      CIBW_BUILD: ${{ steps.config.outputs.CIBW_BUILD }}
+      PKGNAME: ${{ steps.config.outputs.PKGNAME }}
+      PKGVER: ${{ steps.config.outputs.PKGVER }}
+      PURE: ${{ steps.config.outputs.PURE }}
+      ANACONDA_USER: ${{ steps.config.outputs.ANACONDA_USER }}
+      CONDA_BUILD_ARGS: ${{ steps.config.outputs.CONDA_BUILD_ARGS }}
+      BUILD_OS_LIST: ${{ steps.config.outputs.BUILD_OS_LIST }}
+      RELEASE: ${{ steps.config.outputs.RELEASE }}
+      TESTPYPI_UPLOAD_THIS_RUN: ${{ steps.config.outputs.TESTPYPI_UPLOAD_THIS_RUN }}
+      PYPI_UPLOAD_THIS_RUN: ${{ steps.config.outputs.PYPI_UPLOAD_THIS_RUN }}
+      TEST_ANACONDA_UPLOAD_THIS_RUN: ${{ steps.config.outputs.TEST_ANACONDA_UPLOAD_THIS_RUN }}
+      ANACONDA_UPLOAD_THIS_RUN: ${{ steps.config.outputs.ANACONDA_UPLOAD_THIS_RUN }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Ignore Tags for non-tag pushes
+        if: "!startsWith(github.ref, 'refs/tags/')"
+        run: git tag -d $(git tag --points-at HEAD)
+
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Configure workflow
+        id: config
+        run: |
+          pip install ci-helper
+
+          # Load repo-specific variables and overrides:
+          VARS_FILE=".github/workflows/release-vars.sh"
+          if [ -f "${VARS_FILE}" ]; then
+            source "${VARS_FILE}"
+          fi
+
+          # Python version used to build sdists, pure wheels, and as host Python for
+          # `cibuildwheel`:
+          if [ -z "${DEFAULT_PYTHON}" ]; then
+            # Default to second-most recent supported Python version:
+            DEFAULT_PYTHON=$(ci-helper defaultpython)
+          fi
+
+          # Versions of Python to build conda packages for:
+          if [ -z "${CONDA_PYTHONS}" ]; then
+            # Default to all supported Python versions:
+            CONDA_PYTHONS=$(ci-helper pythons)
+          fi
+
+          # Env var for `cibuildwheel` specifying target Python versions:
+          if [ -z "${CIBW_BUILD}" ]; then
+            # default to all supported CPython versions:
+            CIBW_BUILD=$(ci-helper pythons --cibw)
+          fi
+
+          # Package name and version
+          if [ -z "${PKGNAME}" ]; then
+            # Default to package name from project metadata:
+            PKGNAME=$(ci-helper distinfo name .)
+          fi
+          if [ -z "${PKGVER}" ]; then
+            # Default to package version from project metadata:
+            PKGVER=$(ci-helper distinfo version .)
+          fi
+
+          # Whether the package is pure python
+          if [ -z "${PURE}" ]; then
+            # Default to whether the setuptools package declares no modules/libraries:
+            PURE=$(ci-helper distinfo is_pure .)
+          fi
+
+          # Whether the package requirements depend on platform or Python version:
+          if [ -z "${HAS_ENV_MARKERS}" ]; then
+            # Default to the presence of env markers in package metadata:
+            HAS_ENV_MARKERS=$(ci-helper distinfo has_env_markers .)
+          fi
+
+          # List of OSs we need to run the build job on and arguments to
+          # `setuptools-conda build`:
+          if [[ "${PURE}" == false || "${HAS_ENV_MARKERS}" == true ]]; then
+            BUILD_OS_LIST="${OS_LIST_ALL}"
+            CONDA_BUILD_ARGS="--pythons=${CONDA_PYTHONS}"
+          else
+            BUILD_OS_LIST="${OS_LIST_UBUNTU}"
+            CONDA_BUILD_ARGS="--noarch"
+          fi
+
+          # Release if a tag was pushed:
+          if [ "${{ contains(github.ref, '/tags') }}" == true ]; then
+            RELEASE=true
+          else
+            RELEASE=false
+          fi
+
+          # What types of package uploads are enabled:
+          if [ -z "${PYPI_UPLOAD}" ]; then
+            PYPI_UPLOAD=true
+          else
+            PYPI_UPLOAD=false
+          fi
+          if [ -z "${TESTPYPI_UPLOAD}" ]; then
+            TESTPYPI_UPLOAD=true
+          else
+            TESTPYPI_UPLOAD=false
+          fi
+          if [ -z "${ANACONDA_UPLOAD}" ]; then
+            ANACONDA_UPLOAD=true
+          else
+            ANACONDA_UPLOAD=false
+          fi
+          if [ -z "${TEST_ANACONDA_UPLOAD}" ]; then
+            TEST_ANACONDA_UPLOAD=true
+          else
+            TEST_ANACONDA_UPLOAD=false
+          fi
+
+          if [ "${{ github.repository }}" != "${RELEASE_REPO}" ]; then
+            echo "Workflow repo doesn't match ${RELEASE_REPO}, disabling package uploads"
+            PYPI_UPLOAD=false
+            TESTPYPI_UPLOAD=false
+            ANACONDA_UPLOAD=false
+            TEST_ANACONDA_UPLOAD=false
+          fi
+
+          # If Anaconda uploads enabled, check necessary username and token are
+          # available:
+          if [[ "${ANACONDA_UPLOAD}" == true || "${TEST_ANACONDA_UPLOAD}" == true ]]; then
+            if [ -z "${{ secrets.ANACONDA_API_TOKEN }}" ]; then
+              echo "Anaconda uploads enabled but ANACONDA_API_TOKEN secret not set"
+              exit 1
+            fi
+            if [ -z "${ANACONDA_USER}" ]; then
+              echo "Anaconda uploads enabled but ANACONDA_USER not set"
+              exit 1
+            fi
+          fi
+
+          # If enabled, upload releases to PyPI and Anaconda:
+          if [[ "${RELEASE}" == true && "${PYPI_UPLOAD}" == true ]]; then
+            PYPI_UPLOAD_THIS_RUN=true
+          else
+            PYPI_UPLOAD_THIS_RUN=false
+          fi
+          if [[ "${RELEASE}" == true && "${ANACONDA_UPLOAD}" == true ]]; then
+            ANACONDA_UPLOAD_THIS_RUN=true
+          else
+            ANACONDA_UPLOAD_THIS_RUN=false
+          fi
+
+          # If enabled, upload non-releases to Test PyPI and Anaconda test label:
+          if [[ "${RELEASE}" == false && "${TESTPYPI_UPLOAD}" == true ]]; then
+            TESTPYPI_UPLOAD_THIS_RUN=true
+          else
+            TESTPYPI_UPLOAD_THIS_RUN=false
+          fi
+          if [[ "${RELEASE}" == false && "${TEST_ANACONDA_UPLOAD}" == true ]]; then
+            TEST_ANACONDA_UPLOAD_THIS_RUN=true
+          else
+            TEST_ANACONDA_UPLOAD_THIS_RUN=false
+          fi
+
+          echo "DEFAULT_PYTHON=${DEFAULT_PYTHON}" >> "${GITHUB_OUTPUT}"
+          echo "CIBW_BUILD=${CIBW_BUILD}" >> "${GITHUB_OUTPUT}"
+          echo "PKGNAME=${PKGNAME}" >> "${GITHUB_OUTPUT}"
+          echo "PKGVER=${PKGVER}" >> "${GITHUB_OUTPUT}"
+          echo "PURE=${PURE}" >> "${GITHUB_OUTPUT}"
+          echo "ANACONDA_USER=${ANACONDA_USER}" >> "${GITHUB_OUTPUT}"
+          echo "CONDA_BUILD_ARGS=${CONDA_BUILD_ARGS}" >> "${GITHUB_OUTPUT}"
+          echo "BUILD_OS_LIST=${BUILD_OS_LIST}" >> "${GITHUB_OUTPUT}"
+          echo "RELEASE=${RELEASE}" >> "${GITHUB_OUTPUT}"
+          echo "TESTPYPI_UPLOAD_THIS_RUN=${TESTPYPI_UPLOAD_THIS_RUN}" >> "${GITHUB_OUTPUT}"
+          echo "PYPI_UPLOAD_THIS_RUN=${PYPI_UPLOAD_THIS_RUN}" >> "${GITHUB_OUTPUT}"
+          echo "TEST_ANACONDA_UPLOAD_THIS_RUN=${TEST_ANACONDA_UPLOAD_THIS_RUN}" >> "${GITHUB_OUTPUT}"
+          echo "ANACONDA_UPLOAD_THIS_RUN=${ANACONDA_UPLOAD_THIS_RUN}" >> "${GITHUB_OUTPUT}"
+
+          echo
+          echo "=========================="
+          echo "Workflow run configuration:"
+          echo "--------------------------"
+          cat "${GITHUB_OUTPUT}"
+          echo "=========================="
+          echo
+
+
+  build:
+    name: Build
+    runs-on: ${{ matrix.os }}
+    needs: configure
+    strategy:
+      matrix:
+        os: ${{ fromJSON(needs.configure.outputs.BUILD_OS_LIST) }}
+
+    env:
+      DEFAULT_PYTHON: ${{ needs.configure.outputs.DEFAULT_PYTHON }}
+      CIBW_BUILD: ${{ needs.configure.outputs.CIBW_BUILD }}
+      PURE: ${{ needs.configure.outputs.PURE }}
+      CONDA_BUILD_ARGS: ${{ needs.configure.outputs.CONDA_BUILD_ARGS }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Ignore Tags for non-tag pushes
+        if: "!startsWith(github.ref, 'refs/tags/')"
+        run: git tag -d $(git tag --points-at HEAD)
+
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+
+      - name: Install Python tools
+        run: python -m pip install --upgrade pip setuptools wheel build cibuildwheel
+
+      - name: Source distribution
+        if: strategy.job-index == 0
+        run: python -m build -s .
+
+      - name: Wheel distribution (pure)
+        if: env.PURE == 'true' && strategy.job-index == 0
+        run: python -m build -w .
+
+      - name: Wheel distribution (impure)
+        if: env.PURE == 'false'
+        run: cibuildwheel --output-dir dist
+
+      - name: Upload artifact
+        if: env.PURE == 'false' || strategy.job-index == 0
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist-${{ matrix.os }}
+          path: ./dist
+          if-no-files-found: error
+
+      - name: Install Miniforge
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          miniforge-version: "latest"
+          auto-update-conda: true
+          conda-remove-defaults: true
+          auto-activate-base: true
+          activate-environment: ""
+
+      - name: Conda package
+        shell: bash -l {0}
+        run: |
+          if [ "${{ runner.os }}" == Windows ]; then
+            # Short path to minimise odds of hitting Windows max path length
+            CONDA_BUILD_ARGS+=" --croot ${{ runner.temp }}\cb"
+          fi
+          conda install -c labscript-suite setuptools-conda "conda-build<25"
+          setuptools-conda build $CONDA_BUILD_ARGS .
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: conda_packages-${{ matrix.os }}
+          path: ./conda_packages
+          if-no-files-found: error
+
+
+  github-release:
+    name: Publish release (GitHub)
+    runs-on: ubuntu-latest
+    needs: [configure, build]
+    if: ${{ needs.configure.outputs.RELEASE == 'true' }}
+    permissions:
+      contents: write
+    env:
+      PKGNAME: ${{ needs.configure.outputs.PKGNAME }}
+      PKGVER: ${{ needs.configure.outputs.PKGVER }}
+
+    steps:
+      - name: Download Artifact
+        uses: actions/download-artifact@v4
+        with:
+          pattern: dist*
+          path: ./dist
+          merge-multiple: true
+
+      - name: Create GitHub release and upload release asset
+        uses: softprops/action-gh-release@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.event.ref }}
+          name: ${{ env.PKGNAME }} ${{ env.PKGVER }}
+          draft: true
+          prerelease: ${{ contains(github.event.ref, 'rc') }}
+          files: ./dist/*.tar.gz
+
+
+  testpypi-upload:
+    name: Publish on Test PyPI
+    runs-on: ubuntu-latest
+    needs: [configure, build]
+    if: ${{ needs.configure.outputs.TESTPYPI_UPLOAD_THIS_RUN == 'true' }}
+    env:
+      PKGNAME: ${{ needs.configure.outputs.PKGNAME }}
+      PKGVER: ${{ needs.configure.outputs.PKGVER }}
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/project/${{ env.PKGNAME }}/${{ env.PKGVER }}
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download Artifact
+        uses: actions/download-artifact@v4
+        with:
+          pattern: dist*
+          path: ./dist
+          merge-multiple: true
+
+      - name: Publish on TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+
+  pypi-upload:
+    name: Publish on PyPI
+    runs-on: ubuntu-latest
+    needs: [configure, build]
+    if: ${{ needs.configure.outputs.PYPI_UPLOAD_THIS_RUN == 'true' }}
+    env:
+      PKGNAME: ${{ needs.configure.outputs.PKGNAME }}
+      PKGVER: ${{ needs.configure.outputs.PKGVER }}
+    environment:
+      name: pypi
+      url: https://pypi.org/project/${{ env.PKGNAME }}/${{ env.PKGVER }}
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download Artifact
+        uses: actions/download-artifact@v4
+        with:
+          pattern: dist*
+          path: ./dist
+          merge-multiple: true
+
+      - name: Publish on PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+
+  test-anaconda-upload:
+    name: Publish on Anaconda (test label)
+    runs-on: ubuntu-latest
+    needs: [configure, build]
+    if: ${{ needs.configure.outputs.TEST_ANACONDA_UPLOAD_THIS_RUN == 'true' }}
+
+    steps:
+      - name: Download Artifact
+        uses: actions/download-artifact@v4
+        with:
+          pattern: conda_packages-*
+          path: ./conda_packages
+          merge-multiple: true
+
+      - name: Install Miniforge
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          miniforge-version: "latest"
+          auto-update-conda: true
+          conda-remove-defaults: true
+          auto-activate-base: true
+          activate-environment: ""
+
+      - name: Install Anaconda cloud client
+        shell: bash -l {0}
+        run: conda install anaconda-client
+
+      - name: Publish to Anaconda test label
+        shell: bash -l {0}
+        run: |
+          anaconda \
+            --token ${{ secrets.ANACONDA_API_TOKEN }} \
+            upload \
+            --skip-existing \
+            --user ${{ needs.configure.outputs.ANACONDA_USER }} \
+            --label test \
+            conda_packages/*/*
+
+
+  anaconda-upload:
+    name: Publish on Anaconda
+    runs-on: ubuntu-latest
+    needs: [configure, build]
+    if: ${{ needs.configure.outputs.ANACONDA_UPLOAD_THIS_RUN == 'true' }}
+
+    steps:
+      - name: Download Artifact
+        uses: actions/download-artifact@v4
+        with:
+          pattern: conda_packages-*
+          path: ./conda_packages
+          merge-multiple: true
+
+      - name: Install Miniforge
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          miniforge-version: "latest"
+          auto-update-conda: true
+          conda-remove-defaults: true
+          auto-activate-base: true
+          activate-environment: ""
+
+      - name: Install Anaconda cloud client
+        shell: bash -l {0}
+        run: conda install anaconda-client
+
+      - name: Publish to Anaconda main
+        shell: bash -l {0}
+        run: |
+          anaconda \
+            --token ${{ secrets.ANACONDA_API_TOKEN }} \
+            upload \
+            --skip-existing \
+            --user ${{ needs.configure.outputs.ANACONDA_USER }} \
+            conda_packages/*/*

labscript_utils-3.4.0/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: labscript-utils
+Version: 3.4.0
+Summary: Shared utilities for the labscript suite
+Author-email: The labscript suite community <labscriptsuite@googlegroups.com>
+License: Copyright (c) 2013, Monash University
+        All rights reserved.
+        
+        This project (labscript_utils) is dual licensed under the 2-clause BSD license and 3-clause BSD license (see the files BSD-2-CLAUSE-LICENSE.txt and BSD-3-CLAUSE-LICENSE.txt), subject to the following conditions:
+        
+        1) If you wish to use this project with PySide and/or a commercial license of PyQt, the use of this project is governed by the terms of one of the licenses, chosen at your discretion.
+        
+        2) If you wish to use this project with the free (GPLv2 or GPLv3 licensed) version of PyQt, the use of this project is governed by the terms of the 3-clause BSD license only, along with the terms specified in the GPL_EXCEPTIONS.TXT file in the PyQt project source code.
+        
+        These terms are in place to guarantee compatibility with the terms outlined in the GPL License Exceptions of the PyQt project (see the GPL_EXCEPTIONS.TXT file in the source code of the PyQt project)
+Project-URL: Homepage, http://labscriptsuite.org/
+Project-URL: Documentation, https://docs.labscriptsuite.org/
+Project-URL: Repository, https://github.com/labscript-suite/labscript-utils/
+Project-URL: Downloads, https://github.com/labscript-suite/labscript-utils/releases/
+Project-URL: Tracker, https://github.com/labscript-suite/labscript-utils/issues/
+Keywords: experiment control,automation
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: h5py>=2.9
+Requires-Dist: numpy>=1.15
+Requires-Dist: packaging>=20.4
+Requires-Dist: pyqtgraph>=0.11.0rc0
+Requires-Dist: qtutils>=4.0
+Requires-Dist: scipy
+Requires-Dist: zprocess>=2.18.0
+Requires-Dist: setuptools_scm>=4.1.0
+Provides-Extra: docs
+Requires-Dist: PyQt5; extra == "docs"
+Requires-Dist: Sphinx==7.2.6; extra == "docs"
+Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "docs"
+Requires-Dist: myst_parser==2.0.0; extra == "docs"
+Dynamic: license-file
+
+<img src="https://raw.githubusercontent.com/labscript-suite/labscript-suite/master/art/labscript_32nx32n.svg" height="64" alt="the labscript suite" align="right">
+
+# the _labscript suite_ » labscript-utils
+
+### Shared modules used by the _labscript suite_
+
+[![Actions Status](https://github.com/labscript-suite/labscript-utils/workflows/Build%20and%20Release/badge.svg)](https://github.com/labscript-suite/labscript-utils/actions)
+[![License](https://img.shields.io/pypi/l/labscript-utils.svg)](https://github.com/labscript-suite/labscript-utils/raw/master/LICENSE.txt)
+[![Python Version](https://img.shields.io/pypi/pyversions/labscript-utils.svg)](https://python.org)
+[![PyPI](https://img.shields.io/pypi/v/labscript-utils.svg)](https://pypi.org/project/labscript-utils)
+[![Conda Version](https://img.shields.io/conda/v/labscript-suite/labscript-utils)](https://anaconda.org/labscript-suite/labscript-utils)
+[![Google Group](https://img.shields.io/badge/Google%20Group-labscriptsuite-blue.svg)](https://groups.google.com/forum/#!forum/labscriptsuite)
+<!-- [![DOI](http://img.shields.io/badge/DOI-10.1063%2F1.4817213-0F79D0.svg)](https://doi.org/10.1063/1.4817213) -->
+
+
+Shared modules used by the [*labscript suite*](https://github.com/labscript-suite/labscript-suite). Includes a graphical exception handler, debug tools, configuration management, cross-platform filepath conversions, physical unit conversions and custom GUI widgets.
+
+
+## Installation
+
+labscript-utils is distributed as a Python package on [PyPI](https://pypi.org/user/labscript-suite) and [Anaconda Cloud](https://anaconda.org/labscript-suite), and should be installed with other components of the _labscript suite_. Please see the [installation guide](https://docs.labscriptsuite.org/en/latest/installation) for details.

{labscript-utils-3.3.0rc1 → labscript_utils-3.4.0}/README.md

@@ -4,7 +4,7 @@
 
 ### Shared modules used by the _labscript suite_
 
-[![Actions Status](https://github.com/labscript-suite/labscript-utils/workflows/Build%20and%20Release/badge.svg?branch=maintenance%2F3.0.x)](https://github.com/labscript-suite/labscript-utils/actions)
+[![Actions Status](https://github.com/labscript-suite/labscript-utils/workflows/Build%20and%20Release/badge.svg)](https://github.com/labscript-suite/labscript-utils/actions)
 [![License](https://img.shields.io/pypi/l/labscript-utils.svg)](https://github.com/labscript-suite/labscript-utils/raw/master/LICENSE.txt)
 [![Python Version](https://img.shields.io/pypi/pyversions/labscript-utils.svg)](https://python.org)
 [![PyPI](https://img.shields.io/pypi/v/labscript-utils.svg)](https://pypi.org/project/labscript-utils)

{labscript-utils-3.3.0rc1 → labscript_utils-3.4.0}/docs/source/conf.py

@@ -13,8 +13,6 @@
 import copy
 import os
 from pathlib import Path
-from m2r import MdInclude
-from recommonmark.transform import AutoStructify
 from jinja2 import FileSystemLoader, Environment
 
 # -- Project information (unique to each project) -------------------------------------
@@ -47,7 +45,7 @@ extensions = [
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinx_rtd_theme",
-    "recommonmark",
+    "myst_parser",
 ]
 
 autodoc_typehints = 'description'
@@ -73,6 +71,7 @@ del __fn
 
 # Prefix each autosectionlabel with the name of the document it is in and a colon
 autosectionlabel_prefix_document = True
+myst_heading_anchors = 2
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -211,23 +210,8 @@ html_static_path = ['_static']
 # Customize the html_theme
 html_theme_options = {'navigation_depth': 3}
 
-# Use m2r only for mdinclude and recommonmark for everything else
-# https://github.com/readthedocs/recommonmark/issues/191#issuecomment-622369992
 def setup(app):
-    config = {
-        # 'url_resolver': lambda url: github_doc_root + url,
-        'auto_toc_tree_section': 'Contents',
-        'enable_eval_rst': True,
-    }
-    app.add_config_value('recommonmark_config', config, True)
-    app.add_transform(AutoStructify)
-
-    # from m2r to make `mdinclude` work
-    app.add_config_value('no_underscore_emphasis', False, 'env')
-    app.add_config_value('m2r_parse_relative_links', False, 'env')
-    app.add_config_value('m2r_anonymous_references', False, 'env')
-    app.add_config_value('m2r_disable_inline_math', False, 'env')
-    app.add_directive('mdinclude', MdInclude)
+    
     app.add_css_file('custom.css')
 
     # generate the components.rst file dynamically so it points to stable/latest