summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPierre de Buyl <pdebuyl@pdebuyl.be>2021-11-10 23:05:42 +0100
committerPierre de Buyl <pdebuyl@pdebuyl.be>2021-12-08 15:29:33 +0100
commit3995a59352e878efeebed23d2c2af83cf2787af3 (patch)
tree5d701a60d5fef734146878f8dd52549b4da68d1f
parent2525741592afd597572935402355e9d81dac86bd (diff)
downloadnumpy-3995a59352e878efeebed23d2c2af83cf2787af3.tar.gz
DOC: remove explicit imports in rst files
Add conftest.py and pytest.ini files in doc directory
-rw-r--r--doc/conftest.py12
-rw-r--r--doc/pytest.ini22
-rw-r--r--doc/source/reference/arrays.classes.rst1
-rw-r--r--doc/source/reference/arrays.datetime.rst3
-rw-r--r--doc/source/reference/arrays.dtypes.rst3
-rw-r--r--doc/source/reference/arrays.ndarray.rst3
-rw-r--r--doc/source/reference/arrays.nditer.cython.rst3
-rw-r--r--doc/source/reference/arrays.nditer.rst5
-rw-r--r--doc/source/reference/arrays.scalars.rst3
-rw-r--r--doc/source/reference/c-api/coremath.rst3
-rw-r--r--doc/source/reference/distutils.rst3
-rw-r--r--doc/source/reference/maskedarray.baseclass.rst1
-rw-r--r--doc/source/reference/maskedarray.generic.rst2
-rw-r--r--doc/source/reference/random/generator.rst3
-rw-r--r--doc/source/reference/routines.polynomials.classes.rst3
-rw-r--r--doc/source/reference/routines.polynomials.rst3
-rw-r--r--doc/source/user/absolute_beginners.rst4
-rw-r--r--doc/source/user/basics.broadcasting.rst3
-rw-r--r--doc/source/user/basics.copies.rst3
-rw-r--r--doc/source/user/basics.creation.rst3
-rw-r--r--doc/source/user/basics.indexing.rst3
-rw-r--r--doc/source/user/basics.rec.rst3
-rw-r--r--doc/source/user/basics.ufuncs.rst3
-rw-r--r--doc/source/user/misc.rst3
24 files changed, 35 insertions, 63 deletions
diff --git a/doc/conftest.py b/doc/conftest.py
new file mode 100644
index 000000000..9fdf54d3f
--- /dev/null
+++ b/doc/conftest.py
@@ -0,0 +1,12 @@
+"""
+Pytest configuration and fixtures for the Numpy test suite.
+"""
+import pytest
+import numpy
+
+@pytest.fixture(autouse=True)
+def add_np(doctest_namespace):
+ numpy.random.seed(1)
+ doctest_namespace['np'] = numpy
+
+pytest_plugins = ["pytest_doctestplus"]
diff --git a/doc/pytest.ini b/doc/pytest.ini
new file mode 100644
index 000000000..3b7a42600
--- /dev/null
+++ b/doc/pytest.ini
@@ -0,0 +1,22 @@
+[pytest]
+addopts = -l
+norecursedirs = doc tools numpy/linalg/lapack_lite numpy/core/code_generators
+doctest_optionflags = NORMALIZE_WHITESPACE ELLIPSIS ALLOW_UNICODE ALLOW_BYTES
+junit_family=xunit2
+
+filterwarnings =
+ error
+# Filter out annoying import messages.
+ ignore:Not importing directory
+ ignore:numpy.dtype size changed
+ ignore:numpy.ufunc size changed
+ ignore::UserWarning:cpuinfo,
+ ignore: divide by zero encountered in log
+ ignore: invalid value encountered in log
+# Matrix PendingDeprecationWarning.
+ ignore:the matrix subclass is not
+ ignore:Importing from numpy.matlib is
+# pytest warning when using PYTHONOPTIMIZE
+ ignore:assertions not in test modules or plugins:pytest.PytestConfigWarning
+# TODO: remove below when array_api user warning is removed
+ ignore:The numpy.array_api submodule is still experimental. See NEP 47.
diff --git a/doc/source/reference/arrays.classes.rst b/doc/source/reference/arrays.classes.rst
index 92c271f6b..4e908678d 100644
--- a/doc/source/reference/arrays.classes.rst
+++ b/doc/source/reference/arrays.classes.rst
@@ -7,7 +7,6 @@ Standard array subclasses
.. currentmodule:: numpy
.. for doctests
- >>> import numpy as np
>>> np.random.seed(1)
.. note::
diff --git a/doc/source/reference/arrays.datetime.rst b/doc/source/reference/arrays.datetime.rst
index 37e0a5463..63c93821b 100644
--- a/doc/source/reference/arrays.datetime.rst
+++ b/doc/source/reference/arrays.datetime.rst
@@ -2,9 +2,6 @@
.. _arrays.datetime:
-.. for doctest:
- >>> import numpy as np
-
************************
Datetimes and Timedeltas
************************
diff --git a/doc/source/reference/arrays.dtypes.rst b/doc/source/reference/arrays.dtypes.rst
index aec5539e8..8606bc8f1 100644
--- a/doc/source/reference/arrays.dtypes.rst
+++ b/doc/source/reference/arrays.dtypes.rst
@@ -1,8 +1,5 @@
.. currentmodule:: numpy
-.. for doctest:
- >>> import numpy as np
-
.. _arrays.dtypes:
**********************************
diff --git a/doc/source/reference/arrays.ndarray.rst b/doc/source/reference/arrays.ndarray.rst
index 889fb103c..66ebb66fb 100644
--- a/doc/source/reference/arrays.ndarray.rst
+++ b/doc/source/reference/arrays.ndarray.rst
@@ -1,8 +1,5 @@
.. currentmodule:: numpy
-.. for doctest:
- >>> import numpy as np
-
.. _arrays.ndarray:
******************************************
diff --git a/doc/source/reference/arrays.nditer.cython.rst b/doc/source/reference/arrays.nditer.cython.rst
index 9e51162f2..66485fc8a 100644
--- a/doc/source/reference/arrays.nditer.cython.rst
+++ b/doc/source/reference/arrays.nditer.cython.rst
@@ -1,6 +1,3 @@
-.. for doctest:
- >>> import numpy as np
-
Putting the Inner Loop in Cython
================================
diff --git a/doc/source/reference/arrays.nditer.rst b/doc/source/reference/arrays.nditer.rst
index 89074d517..8cabc1a06 100644
--- a/doc/source/reference/arrays.nditer.rst
+++ b/doc/source/reference/arrays.nditer.rst
@@ -1,10 +1,5 @@
.. currentmodule:: numpy
-.. for doctests
- The last section on Cython is 'included' at the end of this file. The tests
- for that section are disabled.
- >>> import numpy as np
-
.. _arrays.nditer:
*********************
diff --git a/doc/source/reference/arrays.scalars.rst b/doc/source/reference/arrays.scalars.rst
index 42fdd18bb..c691e802f 100644
--- a/doc/source/reference/arrays.scalars.rst
+++ b/doc/source/reference/arrays.scalars.rst
@@ -1,6 +1,3 @@
-.. for doctest:
- >>> import numpy as np
-
.. _arrays.scalars:
*******
diff --git a/doc/source/reference/c-api/coremath.rst b/doc/source/reference/c-api/coremath.rst
index 2a851e937..e129fdd77 100644
--- a/doc/source/reference/c-api/coremath.rst
+++ b/doc/source/reference/c-api/coremath.rst
@@ -1,6 +1,3 @@
-.. for doctest:
- >>> import numpy as np
-
NumPy core libraries
====================
diff --git a/doc/source/reference/distutils.rst b/doc/source/reference/distutils.rst
index 33ebeb62c..9db757c89 100644
--- a/doc/source/reference/distutils.rst
+++ b/doc/source/reference/distutils.rst
@@ -1,6 +1,3 @@
-.. for doctest:
- >>> import numpy as np
-
**********************************
Packaging (:mod:`numpy.distutils`)
**********************************
diff --git a/doc/source/reference/maskedarray.baseclass.rst b/doc/source/reference/maskedarray.baseclass.rst
index 5a0f99651..44792a0d6 100644
--- a/doc/source/reference/maskedarray.baseclass.rst
+++ b/doc/source/reference/maskedarray.baseclass.rst
@@ -1,7 +1,6 @@
.. currentmodule:: numpy.ma
.. for doctests
- >>> import numpy as np
>>> from numpy import ma
.. _numpy.ma.constants:
diff --git a/doc/source/reference/maskedarray.generic.rst b/doc/source/reference/maskedarray.generic.rst
index 4d8d9750a..29fc2fe07 100644
--- a/doc/source/reference/maskedarray.generic.rst
+++ b/doc/source/reference/maskedarray.generic.rst
@@ -433,7 +433,7 @@ and entries of the output masked array are masked wherever the corresponding
input fall outside the validity domain::
>>> x = ma.array([-1, 1, 0, 2, 3], mask=[0, 0, 0, 0, 1])
- >>> np.log(x) # doctest: +SKIP
+ >>> np.log(x)
masked_array(data=[--, 0.0, --, 0.6931471805599453, --],
mask=[ True, False, True, False, True],
fill_value=1e+20)
diff --git a/doc/source/reference/random/generator.rst b/doc/source/reference/random/generator.rst
index 4a863ebf3..ecf3f45e8 100644
--- a/doc/source/reference/random/generator.rst
+++ b/doc/source/reference/random/generator.rst
@@ -12,9 +12,6 @@ random values from useful distributions. The default BitGenerator used by
can be changed by passing an instantized BitGenerator to ``Generator``.
-.. for doctest:
- >>> import numpy as np
-
.. autofunction:: default_rng
.. autoclass:: Generator
diff --git a/doc/source/reference/routines.polynomials.classes.rst b/doc/source/reference/routines.polynomials.classes.rst
index e36ef6e97..fd5b0a7e3 100644
--- a/doc/source/reference/routines.polynomials.classes.rst
+++ b/doc/source/reference/routines.polynomials.classes.rst
@@ -1,6 +1,3 @@
-.. for doctest:
- >>> import numpy as np
-
Using the Convenience Classes
=============================
diff --git a/doc/source/reference/routines.polynomials.rst b/doc/source/reference/routines.polynomials.rst
index 75bed4694..4aea963c0 100644
--- a/doc/source/reference/routines.polynomials.rst
+++ b/doc/source/reference/routines.polynomials.rst
@@ -1,8 +1,5 @@
.. _routines.polynomial:
-.. for doctest:
- >>> import numpy as np
-
Polynomials
***********
diff --git a/doc/source/user/absolute_beginners.rst b/doc/source/user/absolute_beginners.rst
index 4e6ffb23d..ecbc37bfa 100644
--- a/doc/source/user/absolute_beginners.rst
+++ b/doc/source/user/absolute_beginners.rst
@@ -5,10 +5,6 @@ NumPy: the absolute basics for beginners
.. currentmodule:: numpy
-.. for doctest:
- >>> import numpy
- >>> import numpy as np
-
Welcome to the absolute beginner's guide to NumPy! If you have comments or
suggestions, please don’t hesitate to `reach out
<https://numpy.org/community/>`_!
diff --git a/doc/source/user/basics.broadcasting.rst b/doc/source/user/basics.broadcasting.rst
index fced0fd2b..7d4c185b6 100644
--- a/doc/source/user/basics.broadcasting.rst
+++ b/doc/source/user/basics.broadcasting.rst
@@ -1,9 +1,6 @@
.. _basics.broadcasting:
.. _array-broadcasting-in-numpy:
-.. for doctest:
- >>> import numpy as np
-
************
Broadcasting
************
diff --git a/doc/source/user/basics.copies.rst b/doc/source/user/basics.copies.rst
index 7f023d877..482cbc189 100644
--- a/doc/source/user/basics.copies.rst
+++ b/doc/source/user/basics.copies.rst
@@ -1,8 +1,5 @@
.. _basics.copies-and-views:
-.. for doctest:
- >>> import numpy as np
-
****************
Copies and views
****************
diff --git a/doc/source/user/basics.creation.rst b/doc/source/user/basics.creation.rst
index 8c89dadbb..381eb76e1 100644
--- a/doc/source/user/basics.creation.rst
+++ b/doc/source/user/basics.creation.rst
@@ -1,8 +1,5 @@
.. _arrays.creation:
-.. for doctest:
- >>> import numpy as np
-
**************
Array creation
**************
diff --git a/doc/source/user/basics.indexing.rst b/doc/source/user/basics.indexing.rst
index a6ecc9b05..d435a13e3 100644
--- a/doc/source/user/basics.indexing.rst
+++ b/doc/source/user/basics.indexing.rst
@@ -1,8 +1,5 @@
.. _basics.indexing:
-.. for doctest:
- >>> import numpy as np
-
****************************************
Indexing on :class:`ndarrays <.ndarray>`
****************************************
diff --git a/doc/source/user/basics.rec.rst b/doc/source/user/basics.rec.rst
index ddca857a1..4b4b8815f 100644
--- a/doc/source/user/basics.rec.rst
+++ b/doc/source/user/basics.rec.rst
@@ -1,8 +1,5 @@
.. _structured_arrays:
-.. for doctest:
- >>> import numpy as np
-
*****************
Structured arrays
*****************
diff --git a/doc/source/user/basics.ufuncs.rst b/doc/source/user/basics.ufuncs.rst
index b5945bce0..5e83621aa 100644
--- a/doc/source/user/basics.ufuncs.rst
+++ b/doc/source/user/basics.ufuncs.rst
@@ -2,9 +2,6 @@
.. _ufuncs-basics:
-.. for doctest:
- >>> import numpy as np
-
********************************************
Universal functions (:class:`.ufunc`) basics
********************************************
diff --git a/doc/source/user/misc.rst b/doc/source/user/misc.rst
index 3dbd12e81..8d5ca86f1 100644
--- a/doc/source/user/misc.rst
+++ b/doc/source/user/misc.rst
@@ -1,6 +1,3 @@
-.. for doctest:
- >>> import numpy as np
-
*************
Miscellaneous
*************