From 2c91c718fbb73e496f2d3e94ab19feabc344933a Mon Sep 17 00:00:00 2001
From: Caleb Johnson <caleb.johnson@ibm.com>
Date: Fri, 6 Sep 2024 18:08:41 -0500
Subject: [PATCH] Remove doctest

---
 .github/workflows/test_development_versions.yml | 1 -
 .github/workflows/test_latest_versions.yml      | 1 -
 .github/workflows/test_minimum_versions.yml     | 1 -
 pyproject.toml                                  | 8 ++------
 qiskit_addon_sqd/configuration_recovery.py      | 2 +-
 test/README.md                                  | 9 ---------
 tox.ini                                         | 8 --------
 7 files changed, 3 insertions(+), 27 deletions(-)

diff --git a/.github/workflows/test_development_versions.yml b/.github/workflows/test_development_versions.yml
index 53eafd0..9b4b6b4 100644
--- a/.github/workflows/test_development_versions.yml
+++ b/.github/workflows/test_development_versions.yml
@@ -41,4 +41,3 @@ jobs:
           toxpyversion=$(echo ${{ matrix.python-version }} | sed -E 's/^([0-9]+)\.([0-9]+).*$/\1\2/')
           tox -epy${toxpyversion}
           tox -epy${toxpyversion}-notebook
-          tox -edoctest
diff --git a/.github/workflows/test_latest_versions.yml b/.github/workflows/test_latest_versions.yml
index 522e7bc..022454f 100644
--- a/.github/workflows/test_latest_versions.yml
+++ b/.github/workflows/test_latest_versions.yml
@@ -40,4 +40,3 @@ jobs:
           toxpyversion=$(echo ${{ matrix.python-version }} | sed -E 's/^([0-9]+)\.([0-9]+).*$/\1\2/')
           tox -epy${toxpyversion}
           tox -epy${toxpyversion}-notebook
-          tox -edoctest
diff --git a/.github/workflows/test_minimum_versions.yml b/.github/workflows/test_minimum_versions.yml
index 57dca58..9fe0dd2 100644
--- a/.github/workflows/test_minimum_versions.yml
+++ b/.github/workflows/test_minimum_versions.yml
@@ -37,4 +37,3 @@ jobs:
           toxpyversion=$(echo ${{ matrix.python-version }} | sed -E 's/^([0-9]+)\.([0-9]+).*$/\1\2/')
           tox -epy${toxpyversion}
           tox -epy${toxpyversion}-notebook
-          tox -edoctest
diff --git a/pyproject.toml b/pyproject.toml
index b62015e..84dc6c6 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -33,7 +33,7 @@ dependencies = [
 
 [project.optional-dependencies]
 dev = [
-    "qiskit-addon-sqd[test,doctest,nbtest,lint,docs]",
+    "qiskit-addon-sqd[test,nbtest,lint,docs]",
 ]
 basetest = [
     "tox>=4.0",
@@ -43,10 +43,6 @@ basetest = [
 test = [
     "qiskit-addon-sqd[basetest]",
 ]
-doctest = [
-    "qiskit-addon-sqd[basetest,notebook-dependencies]",
-    "pytest-doctestplus>=1.2.1",
-]
 nbtest = [
     "qiskit-addon-sqd[basetest]",
     "nbmake>=1.5.0",
@@ -71,7 +67,7 @@ notebook-dependencies = [
     "qiskit-ibm-runtime",
 ]
 docs = [
-    "qiskit-addon-sqd[doctest]",
+    "qiskit-addon-sqd[basetest,notebook-dependencies]",
     "qiskit-sphinx-theme~=2.0.0",
     "jupyter-sphinx",
     "sphinx-design",
diff --git a/qiskit_addon_sqd/configuration_recovery.py b/qiskit_addon_sqd/configuration_recovery.py
index b8a9147..f2040bb 100644
--- a/qiskit_addon_sqd/configuration_recovery.py
+++ b/qiskit_addon_sqd/configuration_recovery.py
@@ -68,7 +68,7 @@ def recover_configurations(
     Refine bitstrings based on average orbital occupancy and a target hamming weight.
 
     This function makes the assumption that bit ``i`` represents the same orbital as
-    bit ``i + # orbitals`` in all input bitstrings, s.t. i < # orbitals.
+    bit ``i + # orbitals`` in all input bitstrings, s.t. ``i < # orbitals``.
 
     Args:
         bitstring_matrix: A 2D array of ``bool`` representations of bit
diff --git a/test/README.md b/test/README.md
index 5df046e..30e619e 100644
--- a/test/README.md
+++ b/test/README.md
@@ -53,14 +53,6 @@ The `notebook` and `py##-notebook` environments invoke [nbmake] to ensure that a
 $ tox -e py310-notebook
 ```
 
-## Doctest environment
-
-The `doctest` environment uses [doctest] to execute the code snippets that are embedded into the documentation strings. The tests get run using [pytest].
-
-```sh
-tox -e doctest
-```
-
 ## Coverage environment
 
 The `coverage` environment uses [Coverage.py] to ensure that the fraction of code tested by pytest is above some threshold (enforced to be 100% for new modules).  A detailed, line-by-line coverage report can be viewed by navigating to `htmlcov/index.html` in a web browser.
@@ -97,7 +89,6 @@ If the build succeeds, it can be viewed by navigating to `docs/_build/html/index
 [pylint]: https://github.com/PyCQA/pylint
 [nbqa]: https://github.com/nbQA-dev/nbQA
 [Jupyter]: https://jupyter.org/
-[doctest]: https://docs.python.org/3/library/doctest.html
 [pytest]: https://docs.pytest.org/
 [unittest]: https://docs.python.org/3/library/unittest.html
 [Coverage.py]: https://coverage.readthedocs.io/
diff --git a/tox.ini b/tox.ini
index fda909e..0508dd3 100644
--- a/tox.ini
+++ b/tox.ini
@@ -40,14 +40,6 @@ extras =
 commands =
   pytest --nbmake --nbmake-timeout=3000 {posargs} docs/tutorials/
 
-[testenv:doctest]
-basepython = python3.10
-extras =
-  test
-  doctest
-commands =
-  pytest --doctest-plus --doctest-only
-
 [testenv:coverage]
 deps =
   coverage>=7.5