scipy-doctest 1.6__tar.gz → 1.7__tar.gz

{scipy_doctest-1.6 → scipy_doctest-1.7}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: scipy_doctest
-Version: 1.6
+Version: 1.7
 Summary: Configurable, whitespace-insensitive, floating-point-aware doctest helpers.
 Maintainer-email: SciPy developers <scipy-dev@python.org>
 Requires-Python: >=3.8
@@ -10,20 +10,36 @@ Classifier: License :: OSI Approved :: BSD License
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3
 Classifier: Framework :: Pytest
+License-File: LICENSE
 Requires-Dist: numpy>=1.19.5
 Requires-Dist: pytest
-Requires-Dist: scipy ; extra == "test"
+Requires-Dist: furo==2024.8.6 ; extra == "doc"
+Requires-Dist: myst-parser==4.0.0 ; extra == "doc"
+Requires-Dist: sphinx==8.1.3 ; extra == "doc"
+Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
+Requires-Dist: scipy <= 1.14.1 ; extra == "test"
 Requires-Dist: matplotlib ; extra == "test"
 Project-URL: Home, https://github.com/scipy/scipy_doctest
+Provides-Extra: doc
 Provides-Extra: test
 
 # Floating-point aware, human readable, numpy-compatible doctesting.
 
+[![PyPI version][pypi-version]][pypi-link]
+[![Conda-Forge][conda-badge]][conda-link]
+
+<!-- prettier-ignore-start -->
+[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/scipy-doctest
+[conda-link]:               https://anaconda.org/conda-forge/scipy-doctest
+[pypi-link]:                https://pypi.org/project/scipy-doctest/
+[pypi-version]:             https://img.shields.io/pypi/v/scipy-doctest
+<!-- prettier-ignore-end -->
+
 ## TL;DR
 
 This project extends the standard library `doctest` module to allow flexibility
 and easy customization of finding, parsing and checking code examples in
-documentation. 
+documentation.
 
 Can be used either as drop-in `doctest` replacement or through the `pytest`
 integration. Uses a floating-point aware doctest checker by default.
@@ -31,7 +47,7 @@ integration. Uses a floating-point aware doctest checker by default.
 ## Motivation and scope
 
 Having examples in the documentation is great. Having wrong examples in the
-documentation is not that great however. 
+documentation is not that great however.
 
 The standard library `doctest` module is great for making sure that docstring
 examples are correct. However, the `doctest` module is limited in several
@@ -46,7 +62,7 @@ This looks reasonably clear but does not work, in three different ways.
 _First_, `1/3` is not equal to 0.333 because floating-point arithmetic.
 _Second_, `numpy` adds whitespace to its output, this whitespace confuses the
 `doctest`, which is whitespace-sensitive. Therefore, we added a magic directive,
- `+SKIP` to avoid a doctest error. _Third_, the example is actually
+`+SKIP` to avoid a doctest error. _Third_, the example is actually
 wrong---notice `0.669` which is not equal to `2/3` to three sig figs. The error
 went unnoticed by the doctester also because of the `+SKIP` directive.
 
@@ -56,44 +72,44 @@ a human reader, and should not be present in the documentation.
 This package defines modified doctesting routines which fix these deficiencies.
 Its main features are
 
-- *Doctesting is floating-point aware.* In a nutshell, the core check is
+- _Doctesting is floating-point aware._ In a nutshell, the core check is
   `np.allclose(want, got, atol=..., rtol=...)`, with user-controllable abs
   and relative tolerances. In the example above (_sans_ `# doctest: +SKIP`),
   `want` is the desired output, `array([0.333, 0.669, 1])` and `got` is the
   actual output from numpy: `array([0.33333333, 0.66666667, 1.        ])`.
 
-- *Human-readable skip markers.* Consider
+- _Human-readable skip markers._ Consider
   ```
   >>> np.random.randint(100)
   42     # may vary
   ```
-Note that the markers (by default, `"# may vary"` and `"# random"`) can be applied
-to either an example's output, or its source.
+  Note that the markers (by default, `"# may vary"` and `"# random"`) can be applied
+  to either an example's output, or its source.
 
 Also note a difference with respect to the standard `# doctest: +SKIP`: the latter
 skips the example entirely, while these additional markers only skip checking
 the output. Thus the example source needs to be valid python code still.
 
-- A user-configurable list of *stopwords*. If an example contains a stopword,
+- A user-configurable list of _stopwords_. If an example contains a stopword,
   it is checked to be valid python, but the output is not checked. This can
   be useful e.g. for not littering the documentation with the output of
   `import matplotlib.pyplot as plt; plt.xlim([2.3, 4.5])`.
 
-- A user-configurable list of *pseudocode* markers. If an example contains one
+- A user-configurable list of _pseudocode_ markers. If an example contains one
   of these markers, it is considered pseudocode and is not checked.
   This is useful for `from example import some_functions` and similar stanzas.
 
 - A `# doctest: +SKIPBLOCK` option flag to skip whole blocks of pseudocode. Here
   a 'block' is a sequence of doctest examples without any intervening text.
 
-- *Doctest discovery* is somewhat more flexible then the standard library
+- _Doctest discovery_ is somewhat more flexible then the standard library
   `doctest` module. Specifically, one can use `testmod(module, strategy='api')`
   to only examine public objects of a module. This is helpful for complex
   packages, with non-trivial internal file structure. Alternatively, the default
   value of `strategy=None` is equivalent to the standard `doctest` module
   behavior.
 
-- *User configuration*. Essentially all aspects of the behavior are user
+- _User configuration_. Essentially all aspects of the behavior are user
   configurable via a `DTConfig` instance attributes. See the `DTConfig`
   docstring for details.
 
@@ -124,7 +140,7 @@ pip install scipy-doctest
 
 2. **Register or load the plugin**
 
-Next, you need to register or load the pytest plugin within your test module or `conftest.py` file. 
+Next, you need to register or load the pytest plugin within your test module or `conftest.py` file.
 
 To do this, add the following line of code:
 
@@ -136,14 +152,16 @@ pytest_plugins = "scipy_doctest"
 
 Check out the [pytest documentation](https://docs.pytest.org/en/stable/how-to/writing_plugins.html#requiring-loading-plugins-in-a-test-module-or-conftest-file) for more information on requiring/loading plugins in a test module or `conftest.py` file.
 
-3. **Run doctests** 
+3. **Run doctests**
 
 Once the plugin is registered, run the doctests by executing the following command:
 
 ```bash
 $ python -m pytest --doctest-modules
 ```
+
 or
+
 ```bash
 $ pytest --pyargs <your-package> --doctest-modules
 ```
@@ -155,10 +173,9 @@ use the command flag
 $ pytest --pyargs <your-package> --doctest-modules --doctest-collect=api
 ```
 
-See [More fine-grained control](https://github.com/scipy/scipy_doctest#More-fine-grained-control) section
+See [More fine-grained control](#more-fine-grained-control) section
 for details on how to customize the behavior.
 
-
 ### Basic usage
 
 The use of `pytest` is optional, and you can use the `doctest` layer API.
@@ -171,6 +188,7 @@ For example,
 >>> res
 TestResults(failed=0, attempted=764)
 ```
+
 The second return value, `hist` is a dict which maps the names of the objects
 to the numbers of failures and attempts for individual examples.
 
@@ -178,10 +196,10 @@ For more details, see the `testmod` docstring. Other useful functions are
 `find_doctests`, `run_docstring_examples` and `testfile` (the latter two mimic
 the behavior of the eponymous functions of the `doctest` module).
 
-
 ### Command-line interface
 
 There is a basic CLI, which also mimics that of the `doctest` module:
+
 ```
 $ python -m scipy_doctest foo.py
 ```
@@ -190,28 +208,30 @@ Note that, just like `$ python -m doctest foo.py`, this may
 fail if `foo.py` is a part of a package due to package imports.
 
 Text files can also be CLI-checked:
+
 ```
 $ python -m scipy_doctest bar.rst
 ```
 
 Notice that the command-line usage only uses the default `DTConfig` settings.
 
+(more-fine-grained-control)=
 
 ## More fine-grained control
 
 More fine-grained control of the functionality is available via the following
 classes
 
-|   Class     |  `doctest` analog  |
-|-------------|--------------------|
-| `DTChecker` | `DocTestChecker`   |
-| `DTParser`  | `DocTestParser`    |
-| `DTRunner`  | `DocTestRunner`    |
-| `DTFinder`  | `DocTestFinder`    |
-| `DTContext` |       --           |
+| Class       | `doctest` analog |
+| ----------- | ---------------- |
+| `DTChecker` | `DocTestChecker` |
+| `DTParser`  | `DocTestParser`  |
+| `DTRunner`  | `DocTestRunner`  |
+| `DTFinder`  | `DocTestFinder`  |
+| `DTContext` | --               |
 
 The `DTContext` class is just a bag class which holds various configuration
-settings as attributes.  An instance of this class is passed around, so user
+settings as attributes. An instance of this class is passed around, so user
 configuration is simply creating an instance, overriding an attribute and
 passing the instance to `testmod` or constructors of `DT*` objects. Defaults
 are provided, based on a long-term usage in SciPy.
@@ -220,7 +240,7 @@ See the [DTConfig docstring](https://github.com/scipy/scipy_doctest/blob/main/sc
 for the full set of attributes that allow you to fine-tune your doctesting experience.
 
 To set any of these attributes, create an instance of `DTConfig` and assign the attributes
-in a usual way. 
+in a usual way.
 
 If using the pytest plugin, it is convenient to use the default instance, which
 is predefined in `scipy_doctest/conftest.py`. This instance will be automatically
@@ -260,14 +280,12 @@ dt_config.skiplist = {
 
 If you don't set these attributes, the [default settings](https://github.com/scipy/scipy_doctest/blob/58ff06a837b7bff1dbac6560013fc6fd07952ae2/scipy_doctest/impl.py#L94) of the attributes are used.
 
-
 #### Alternative Checkers
 
 By default, we use the floating-point aware `DTChecker`. If you want to use an
 alternative checker, all you need to do is to define the corresponding class,
 and add an attribute to the `DTConfig` instance. For example,
 
-
 ```
 class VanillaOutputChecker(doctest.OutputChecker):
     """doctest.OutputChecker to drop in for DTChecker.
@@ -290,10 +308,8 @@ See [a pytest example](https://github.com/scipy/scipy_doctest/blob/main/scipy_do
 and [a doctest example](https://github.com/scipy/scipy_doctest/blob/main/scipy_doctest/tests/test_runner.py#L94)
 for more details.
 
-
 ### NumPy and SciPy wrappers
 
-
 NumPy wraps `scipy-doctest` with the `spin` command
 
 ```
@@ -307,13 +323,11 @@ $ python dev.py smoke-docs    # check docstrings
 $ python dev.py smoke-tutorials   # ReST user guide tutorials
 ```
 
-
-
 ## Rough edges and sharp bits
 
 Here is a (non-exhaustive) list of possible gotchas:
 
-- *In-place development builds*.
+- _In-place development builds_.
 
 Some tools (looking at you `meson-python`) simulate in-place builds with a
 `build-install` directory. If this directory is located under the project root,
@@ -329,12 +343,15 @@ $ pytest build-install/lib/python3.10/site-packages/scipy/ --doctest-modules
 
 instead of `$ pytest --pyargs scipy`.
 
-If push comes to shove, you may try using the magic env variable:
+If you use actual editable installs, of the `pip install --no-build-isolation -e .` variety, you may
+need to add `--import-mode=importlib` to the `pytest` invocation.
+
+If push really comes to shove, you may try using the magic env variable:
 ` PY_IGNORE_IMPORTMISMATCH=1 pytest ...`,
 however the need usually indicates an issue with the package itself.
 (see [gh-107](https://github.com/scipy/scipy_doctest/pull/107) for an example).
 
-- *Optional dependencies are not that optional*
+- _Optional dependencies are not that optional_
 
 If your package contains optional dependencies, doctests do not know about them
 being optional. So you either guard the imports in doctests (yikes!), or
@@ -353,11 +370,11 @@ Note that installed packages are no different:
 $ pytest --pyargs scipy --doctest-modules --ignore=/path/to/installed/scipy/_lib
 ```
 
-- *Doctest collection strategies*
+- _Doctest collection strategies_
 
 The default collection strategy follows `doctest` module and `pytest`. This leads
 to duplicates if your package has the split between public and \_private modules,
-where  public modules re-export things from private ones. The solution is to
+where public modules re-export things from private ones. The solution is to
 use `$ pytest --doctest-collect=api` CLI switch: with this, only public
 objects will be collected.
 
@@ -375,8 +392,7 @@ leads to
 - `scipy.linalg._basic.det`, collected from `scipy/linalg/_basic.py`, is private.
 - `scipy.linalg.det`, collected from `scipy/linalg/__init__.py`, is public.
 
-
-- *`pytest`'s assertion rewriting*
+- _`pytest`'s assertion rewriting_
 
 In some rare cases you may need to either explicitly register the `scipy_doctest`
 package with the `pytest` assertion rewriting machinery, or ask it to avoid rewriting
@@ -388,7 +404,6 @@ In general, rewriting assertions is not very useful for doctests, as the
 output on error is fixed by the doctest machinery anyway. Therefore, we believe
 adding `--assert=plain` is reasonable.
 
-
 ## Prior art and related work
 
 - `pytest` provides some limited floating-point aware `NumericLiteralChecker`.
@@ -409,15 +424,14 @@ adding `--assert=plain` is reasonable.
   to be not easy to reason about, work with, and extend to other projects.
 
   This project is mainly the core functionality of the modified
-  `refguide-check` doctesting, extracted to a separate package. 
+  `refguide-check` doctesting, extracted to a separate package.
   We believe having it separate simplifies both addressing the needs of these
   two packages, and potential adoption by other projects.
 
-
 ### Bug reports, feature requests and contributions
 
 This package is work in progress. Contributions are most welcome!
 Please don't hesitate to open an issue in the tracker or send a pull request.
 
-The current location of the issue tracker is https://github.com/scipy/scipy_doctest.
+The current location of the issue tracker is <https://github.com/scipy/scipy_doctest>.
 

{scipy_doctest-1.6 → scipy_doctest-1.7}/README.md

@@ -1,10 +1,20 @@
 # Floating-point aware, human readable, numpy-compatible doctesting.
 
+[![PyPI version][pypi-version]][pypi-link]
+[![Conda-Forge][conda-badge]][conda-link]
+
+<!-- prettier-ignore-start -->
+[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/scipy-doctest
+[conda-link]:               https://anaconda.org/conda-forge/scipy-doctest
+[pypi-link]:                https://pypi.org/project/scipy-doctest/
+[pypi-version]:             https://img.shields.io/pypi/v/scipy-doctest
+<!-- prettier-ignore-end -->
+
 ## TL;DR
 
 This project extends the standard library `doctest` module to allow flexibility
 and easy customization of finding, parsing and checking code examples in
-documentation. 
+documentation.
 
 Can be used either as drop-in `doctest` replacement or through the `pytest`
 integration. Uses a floating-point aware doctest checker by default.
@@ -12,7 +22,7 @@ integration. Uses a floating-point aware doctest checker by default.
 ## Motivation and scope
 
 Having examples in the documentation is great. Having wrong examples in the
-documentation is not that great however. 
+documentation is not that great however.
 
 The standard library `doctest` module is great for making sure that docstring
 examples are correct. However, the `doctest` module is limited in several
@@ -27,7 +37,7 @@ This looks reasonably clear but does not work, in three different ways.
 _First_, `1/3` is not equal to 0.333 because floating-point arithmetic.
 _Second_, `numpy` adds whitespace to its output, this whitespace confuses the
 `doctest`, which is whitespace-sensitive. Therefore, we added a magic directive,
- `+SKIP` to avoid a doctest error. _Third_, the example is actually
+`+SKIP` to avoid a doctest error. _Third_, the example is actually
 wrong---notice `0.669` which is not equal to `2/3` to three sig figs. The error
 went unnoticed by the doctester also because of the `+SKIP` directive.
 
@@ -37,44 +47,44 @@ a human reader, and should not be present in the documentation.
 This package defines modified doctesting routines which fix these deficiencies.
 Its main features are
 
-- *Doctesting is floating-point aware.* In a nutshell, the core check is
+- _Doctesting is floating-point aware._ In a nutshell, the core check is
   `np.allclose(want, got, atol=..., rtol=...)`, with user-controllable abs
   and relative tolerances. In the example above (_sans_ `# doctest: +SKIP`),
   `want` is the desired output, `array([0.333, 0.669, 1])` and `got` is the
   actual output from numpy: `array([0.33333333, 0.66666667, 1.        ])`.
 
-- *Human-readable skip markers.* Consider
+- _Human-readable skip markers._ Consider
   ```
   >>> np.random.randint(100)
   42     # may vary
   ```
-Note that the markers (by default, `"# may vary"` and `"# random"`) can be applied
-to either an example's output, or its source.
+  Note that the markers (by default, `"# may vary"` and `"# random"`) can be applied
+  to either an example's output, or its source.
 
 Also note a difference with respect to the standard `# doctest: +SKIP`: the latter
 skips the example entirely, while these additional markers only skip checking
 the output. Thus the example source needs to be valid python code still.
 
-- A user-configurable list of *stopwords*. If an example contains a stopword,
+- A user-configurable list of _stopwords_. If an example contains a stopword,
   it is checked to be valid python, but the output is not checked. This can
   be useful e.g. for not littering the documentation with the output of
   `import matplotlib.pyplot as plt; plt.xlim([2.3, 4.5])`.
 
-- A user-configurable list of *pseudocode* markers. If an example contains one
+- A user-configurable list of _pseudocode_ markers. If an example contains one
   of these markers, it is considered pseudocode and is not checked.
   This is useful for `from example import some_functions` and similar stanzas.
 
 - A `# doctest: +SKIPBLOCK` option flag to skip whole blocks of pseudocode. Here
   a 'block' is a sequence of doctest examples without any intervening text.
 
-- *Doctest discovery* is somewhat more flexible then the standard library
+- _Doctest discovery_ is somewhat more flexible then the standard library
   `doctest` module. Specifically, one can use `testmod(module, strategy='api')`
   to only examine public objects of a module. This is helpful for complex
   packages, with non-trivial internal file structure. Alternatively, the default
   value of `strategy=None` is equivalent to the standard `doctest` module
   behavior.
 
-- *User configuration*. Essentially all aspects of the behavior are user
+- _User configuration_. Essentially all aspects of the behavior are user
   configurable via a `DTConfig` instance attributes. See the `DTConfig`
   docstring for details.
 
@@ -105,7 +115,7 @@ pip install scipy-doctest
 
 2. **Register or load the plugin**
 
-Next, you need to register or load the pytest plugin within your test module or `conftest.py` file. 
+Next, you need to register or load the pytest plugin within your test module or `conftest.py` file.
 
 To do this, add the following line of code:
 
@@ -117,14 +127,16 @@ pytest_plugins = "scipy_doctest"
 
 Check out the [pytest documentation](https://docs.pytest.org/en/stable/how-to/writing_plugins.html#requiring-loading-plugins-in-a-test-module-or-conftest-file) for more information on requiring/loading plugins in a test module or `conftest.py` file.
 
-3. **Run doctests** 
+3. **Run doctests**
 
 Once the plugin is registered, run the doctests by executing the following command:
 
 ```bash
 $ python -m pytest --doctest-modules
 ```
+
 or
+
 ```bash
 $ pytest --pyargs <your-package> --doctest-modules
 ```
@@ -136,10 +148,9 @@ use the command flag
 $ pytest --pyargs <your-package> --doctest-modules --doctest-collect=api
 ```
 
-See [More fine-grained control](https://github.com/scipy/scipy_doctest#More-fine-grained-control) section
+See [More fine-grained control](#more-fine-grained-control) section
 for details on how to customize the behavior.
 
-
 ### Basic usage
 
 The use of `pytest` is optional, and you can use the `doctest` layer API.
@@ -152,6 +163,7 @@ For example,
 >>> res
 TestResults(failed=0, attempted=764)
 ```
+
 The second return value, `hist` is a dict which maps the names of the objects
 to the numbers of failures and attempts for individual examples.
 
@@ -159,10 +171,10 @@ For more details, see the `testmod` docstring. Other useful functions are
 `find_doctests`, `run_docstring_examples` and `testfile` (the latter two mimic
 the behavior of the eponymous functions of the `doctest` module).
 
-
 ### Command-line interface
 
 There is a basic CLI, which also mimics that of the `doctest` module:
+
 ```
 $ python -m scipy_doctest foo.py
 ```
@@ -171,28 +183,30 @@ Note that, just like `$ python -m doctest foo.py`, this may
 fail if `foo.py` is a part of a package due to package imports.
 
 Text files can also be CLI-checked:
+
 ```
 $ python -m scipy_doctest bar.rst
 ```
 
 Notice that the command-line usage only uses the default `DTConfig` settings.
 
+(more-fine-grained-control)=
 
 ## More fine-grained control
 
 More fine-grained control of the functionality is available via the following
 classes
 
-|   Class     |  `doctest` analog  |
-|-------------|--------------------|
-| `DTChecker` | `DocTestChecker`   |
-| `DTParser`  | `DocTestParser`    |
-| `DTRunner`  | `DocTestRunner`    |
-| `DTFinder`  | `DocTestFinder`    |
-| `DTContext` |       --           |
+| Class       | `doctest` analog |
+| ----------- | ---------------- |
+| `DTChecker` | `DocTestChecker` |
+| `DTParser`  | `DocTestParser`  |
+| `DTRunner`  | `DocTestRunner`  |
+| `DTFinder`  | `DocTestFinder`  |
+| `DTContext` | --               |
 
 The `DTContext` class is just a bag class which holds various configuration
-settings as attributes.  An instance of this class is passed around, so user
+settings as attributes. An instance of this class is passed around, so user
 configuration is simply creating an instance, overriding an attribute and
 passing the instance to `testmod` or constructors of `DT*` objects. Defaults
 are provided, based on a long-term usage in SciPy.
@@ -201,7 +215,7 @@ See the [DTConfig docstring](https://github.com/scipy/scipy_doctest/blob/main/sc
 for the full set of attributes that allow you to fine-tune your doctesting experience.
 
 To set any of these attributes, create an instance of `DTConfig` and assign the attributes
-in a usual way. 
+in a usual way.
 
 If using the pytest plugin, it is convenient to use the default instance, which
 is predefined in `scipy_doctest/conftest.py`. This instance will be automatically
@@ -241,14 +255,12 @@ dt_config.skiplist = {
 
 If you don't set these attributes, the [default settings](https://github.com/scipy/scipy_doctest/blob/58ff06a837b7bff1dbac6560013fc6fd07952ae2/scipy_doctest/impl.py#L94) of the attributes are used.
 
-
 #### Alternative Checkers
 
 By default, we use the floating-point aware `DTChecker`. If you want to use an
 alternative checker, all you need to do is to define the corresponding class,
 and add an attribute to the `DTConfig` instance. For example,
 
-
 ```
 class VanillaOutputChecker(doctest.OutputChecker):
     """doctest.OutputChecker to drop in for DTChecker.
@@ -271,10 +283,8 @@ See [a pytest example](https://github.com/scipy/scipy_doctest/blob/main/scipy_do
 and [a doctest example](https://github.com/scipy/scipy_doctest/blob/main/scipy_doctest/tests/test_runner.py#L94)
 for more details.
 
-
 ### NumPy and SciPy wrappers
 
-
 NumPy wraps `scipy-doctest` with the `spin` command
 
 ```
@@ -288,13 +298,11 @@ $ python dev.py smoke-docs    # check docstrings
 $ python dev.py smoke-tutorials   # ReST user guide tutorials
 ```
 
-
-
 ## Rough edges and sharp bits
 
 Here is a (non-exhaustive) list of possible gotchas:
 
-- *In-place development builds*.
+- _In-place development builds_.
 
 Some tools (looking at you `meson-python`) simulate in-place builds with a
 `build-install` directory. If this directory is located under the project root,
@@ -310,12 +318,15 @@ $ pytest build-install/lib/python3.10/site-packages/scipy/ --doctest-modules
 
 instead of `$ pytest --pyargs scipy`.
 
-If push comes to shove, you may try using the magic env variable:
+If you use actual editable installs, of the `pip install --no-build-isolation -e .` variety, you may
+need to add `--import-mode=importlib` to the `pytest` invocation.
+
+If push really comes to shove, you may try using the magic env variable:
 ` PY_IGNORE_IMPORTMISMATCH=1 pytest ...`,
 however the need usually indicates an issue with the package itself.
 (see [gh-107](https://github.com/scipy/scipy_doctest/pull/107) for an example).
 
-- *Optional dependencies are not that optional*
+- _Optional dependencies are not that optional_
 
 If your package contains optional dependencies, doctests do not know about them
 being optional. So you either guard the imports in doctests (yikes!), or
@@ -334,11 +345,11 @@ Note that installed packages are no different:
 $ pytest --pyargs scipy --doctest-modules --ignore=/path/to/installed/scipy/_lib
 ```
 
-- *Doctest collection strategies*
+- _Doctest collection strategies_
 
 The default collection strategy follows `doctest` module and `pytest`. This leads
 to duplicates if your package has the split between public and \_private modules,
-where  public modules re-export things from private ones. The solution is to
+where public modules re-export things from private ones. The solution is to
 use `$ pytest --doctest-collect=api` CLI switch: with this, only public
 objects will be collected.
 
@@ -356,8 +367,7 @@ leads to
 - `scipy.linalg._basic.det`, collected from `scipy/linalg/_basic.py`, is private.
 - `scipy.linalg.det`, collected from `scipy/linalg/__init__.py`, is public.
 
-
-- *`pytest`'s assertion rewriting*
+- _`pytest`'s assertion rewriting_
 
 In some rare cases you may need to either explicitly register the `scipy_doctest`
 package with the `pytest` assertion rewriting machinery, or ask it to avoid rewriting
@@ -369,7 +379,6 @@ In general, rewriting assertions is not very useful for doctests, as the
 output on error is fixed by the doctest machinery anyway. Therefore, we believe
 adding `--assert=plain` is reasonable.
 
-
 ## Prior art and related work
 
 - `pytest` provides some limited floating-point aware `NumericLiteralChecker`.
@@ -390,14 +399,13 @@ adding `--assert=plain` is reasonable.
   to be not easy to reason about, work with, and extend to other projects.
 
   This project is mainly the core functionality of the modified
-  `refguide-check` doctesting, extracted to a separate package. 
+  `refguide-check` doctesting, extracted to a separate package.
   We believe having it separate simplifies both addressing the needs of these
   two packages, and potential adoption by other projects.
 
-
 ### Bug reports, feature requests and contributions
 
 This package is work in progress. Contributions are most welcome!
 Please don't hesitate to open an issue in the tracker or send a pull request.
 
-The current location of the issue tracker is https://github.com/scipy/scipy_doctest.
+The current location of the issue tracker is <https://github.com/scipy/scipy_doctest>.

{scipy_doctest-1.6 → scipy_doctest-1.7}/pyproject.toml

@@ -25,13 +25,44 @@ dependencies  = [
 
 [project.optional-dependencies]
 test = [
-    "scipy",
+    "scipy <= 1.14.1",   # black-list 1.5.1 ?
     "matplotlib"
 ]
+doc = [
+    "furo==2024.8.6",
+    "myst-parser==4.0.0",
+    "sphinx==8.1.3",
+    "sphinx-copybutton==0.5.2"
+]
 
 [project.urls]
 Home = "https://github.com/scipy/scipy_doctest"
 
+[tool.ruff.lint]
+select = [
+    # pycodestyle
+    "E",
+    # Pyflakes
+    "F",
+    # pyupgrade
+    "UP",
+    # flake8-bugbear
+    "B",
+    # isort
+    "I",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"scipy_doctest/tests/module_cases.py" = ["E501"]
+"scipy_doctest/tests/local_file_cases.py" = ["E501"]
+
+[tool.ruff.format]
+# Enable reformatting of code snippets in docstrings.
+docstring-code-format = true
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
 [tool.pytest.ini_options]
 addopts = "--verbose --color=yes"
 

scipy_doctest-1.7/scipy_doctest/.ruff_cache/.gitignore

@@ -0,0 +1,2 @@
+# Automatically created by ruff.
+*