8000 DOC: fill in the rest of the optional test dependencies · matplotlib/matplotlib@09bd607 · GitHub
[go: up one dir, main page]

Skip to content

Commit 09bd607

Browse files
tacaswelltimhoffm
andcommitted
DOC: fill in the rest of the optional test dependencies
Also moves inkscape and gs to "optional" testing section because the tests will run with out them (but it will skip the ps / eps / svg tests) Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
1 parent a68f21f commit 09bd607

File tree

1 file changed

+33
-10
lines changed

1 file changed

+33
-10
lines changed

doc/devel/dependencies.rst

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -183,32 +183,55 @@ This section lists the additional software required for
183183
Required:
184184

185185
- pytest_ (>=3.6)
186-
- Ghostscript_ (>= 9.0, to render PDF files)
187-
- Inkscape_ (to render SVG files)
188-
189-
.. note::
190-
191-
When installing Inkscape on Windows, make sure that you select Add
192-
Inkscape to system PATH, either for all users or current user, or the
193-
tests will not find it.
194186

195187
Optional:
196188

189+
In addition to all of the optional dependencies on the main library, for
190+
testing the following will be used if they are installed.
191+
192+
- Ghostscript_ (>= 9.0, to render PDF files)
193+
- Inkscape_ (to render SVG files)
194+
- nbformat_ and nbconvert_ used to test the notebook backend
195+
- pandas_ used to test compatibility with Pandas
196+
- pikepdf_ used in some tests for the pgf and pdf backends
197+
- psutil_ used in testing the interactive backends
197198
- pytest-cov_ (>=2.3.1) to collect coverage information
198199
- pytest-flake8_ to test coding standards using flake8_
199200
- pytest-timeout_ to limit runtime in case of stuck tests
200201
- pytest-xdist_ to run tests in parallel
201202
- pytest-xvfb_ to run tests without windows popping up (Linux)
203+
- pytz_ used to test pytz int
204+
- sphinx_ used to test our sphinx extensions
205+
- WenQuanYi Zen Hei and `Noto Sans CJK <https://fonts.google.com/noto/use>`_
206+
fonts for testing font fallback and non-western fonts
207+
- xarray_ used to test compatibility with xarray
208+
209+
If any of these dependencies are not discovered the tests that rely on them
210+
will be skipped by pytest.
211+
212+
.. note::
213+
214+
When installing Inkscape on Windows, make sure that you select “Add
215+
Inkscape to system PATH”, either for all users or current user, or the
216+
tests will not find it.
202217

203-
.. _pytest: http://doc.pytest.org/en/latest/
204218
.. _Ghostscript: https://www.ghostscript.com/
205219
.. _Inkscape: https://inkscape.org
220+
.. _flake8: https://pypi.org/project/flake8/
221+
.. _nbconvert: https://pypi.org/project/nbconvert/
222+
.. _nbformat: https://pypi.org/project/nbformat/
223+
.. _pandas: https://pypi.org/project/pandas/
224+
.. _pikepdf: https://pypi.org/project/pikepdf/
225+
.. _psutil: https://pypi.org/project/psuitl/
226+
.. _pytz: https://fonts.google.com/noto/use#faq
206227
.. _pytest-cov: https://pytest-cov.readthedocs.io/en/latest/
207228
.. _pytest-flake8: https://pypi.org/project/pytest-flake8/
208229
.. _pytest-timeout: https://pypi.org/project/pytest-timeout/
209230
.. _pytest-xdist: https://pypi.org/project/pytest-xdist/
210231
.. _pytest-xvfb: https://pypi.org/project/pytest-xvfb/
211-
.. _flake8: https://pypi.org/project/flake8/
232+
.. _pytest: http://doc.pytest.org/en/latest/
233+
.. _sphinx: https://pypi.org/project/Sphinx/
234+
.. _xarray: https://pypi.org/project/xarray/
212235

213236

214237
.. _doc-dependencies:

0 commit comments

Comments
 (0)
0