Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit14de76c

Browse files
committed
Move development dependencies to dependencies page
1 parent7a12f32 commit14de76c

File tree

2 files changed

+91
-78
lines changed

2 files changed

+91
-78
lines changed

‎doc/devel/dependencies.rst

Lines changed: 89 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,11 @@
44
Dependencies
55
============
66

7+
Runtime dependencies
8+
====================
9+
710
Mandatory dependencies
8-
======================
11+
----------------------
912

1013
When installing through a package manager like ``pip`` or ``conda``, the
1114
mandatory dependencies are automatically installed. This list is mainly for
@@ -24,13 +27,13 @@ reference.
2427
.. _optional_dependencies:
2528

2629
Optional dependencies
27-
=====================
30+
---------------------
2831

2932
The following packages and tools are not required but extend the capabilities
3033
of Matplotlib.
3134

3235
Backends
33-
--------
36+
~~~~~~~~
3437

3538
Matplotlib figures can be rendered to various user interfaces. See
3639
:ref:`what-is-a-backend` for more details on the optional Matplotlib backends
@@ -65,14 +68,14 @@ and the capabilities they provide.
6568
downloaded from https://wxpython.org/pages/downloads/.
6669
6770
Animations
68-
----------
71+
~~~~~~~~~~
6972

7073
* `ffmpeg<https://www.ffmpeg.org/>`_: for saving movies.
7174
* `ImageMagick<https://www.imagemagick.org/script/index.php>`_: for saving
7275
animated gifs.
7376

7477
Font handling and rendering
75-
---------------------------
78+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
7679

7780
* `LaTeX<https://www.latex-project.org/>`_ (with `cm-super
7881
<https://ctan.org/pkg/cm-super>`__ ) and `GhostScript (>=9.0)
@@ -81,7 +84,7 @@ Font handling and rendering
8184
fonts on Linux.
8285

8386
C libraries
84-
===========
87+
-----------
8588

8689
Matplotlib brings its own copies of the following libraries:
8790

@@ -161,3 +164,83 @@ If you go this route but need to reset and rebuild to change your settings,
161164
remember to clear your artifacts before re-building::
162165

163166
git clean -xfd
167+
168+
169+
.. _development-dependencies:
170+
171+
Additional dependencies for development
172+
=======================================
173+
174+
.. _test-dependencies:
175+
176+
Additional dependencies for testing
177+
===================================
178+
This section lists the additional software required for
179+
:ref:`running the tests<testing>`.
180+
181+
Required:
182+
183+
-pytest_ (>=3.6)
184+
-Ghostscript_ (>= 9.0, to render PDF files)
185+
-Inkscape_ (to render SVG files)
186+
187+
Optional:
188+
189+
-pytest-cov_ (>=2.3.1) to collect coverage information
190+
-pytest-flake8_ to test coding standards usingflake8_
191+
-pytest-timeout_ to limit runtime in case of stuck tests
192+
-pytest-xdist_ to run tests in parallel
193+
194+
.. _pytest:http://doc.pytest.org/en/latest/
195+
.. _Ghostscript:https://www.ghostscript.com/
196+
.. _Inkscape:https://inkscape.org
197+
.. _pytest-cov:https://pytest-cov.readthedocs.io/en/latest/
198+
.. _pytest-flake8:https://pypi.org/project/pytest-flake8/
199+
.. _pytest-xdist:https://pypi.org/project/pytest-xdist/
200+
.. _pytest-timeout:https://pypi.org/project/pytest-timeout/
201+
.. _flake8:https://pypi.org/project/flake8/
202+
203+
204+
.. _doc-dependencies:
205+
206+
Additional dependencies for building documentation
207+
==================================================
208+
209+
Python packages
210+
---------------
211+
The additional Python packages required to build the
212+
:ref:`documentation<documenting-matplotlib>` are listed in
213+
:file:`doc-requirements.txt` and can be installed using ::
214+
215+
pip install -r requirements/doc/doc-requirements.txt
216+
217+
The content of:file:`doc-requirements.txt` is also shown below:
218+
219+
..include::../../requirements/doc/doc-requirements.txt
220+
:literal:
221+
222+
Additional external dependencies
223+
--------------------------------
224+
Required:
225+
226+
* a minimal working LaTeX distribution
227+
* `Graphviz<http://www.graphviz.org/download>`_
228+
* the LaTeX packages *cm-super* and *dvipng* (if your OS bundles TeXLive, the
229+
"complete" version of the installer, e.g. "texlive-full" or "texlive-all",
230+
will often automatically include these packages)
231+
232+
Optional, but recommended:
233+
234+
* `Inkscape<https://inkscape.org>`_
235+
* `optipng<http://optipng.sourceforge.net>`_
236+
* the font "Humor Sans" (aka the "XKCD" font), or the free alternative
237+
`Comic Neue<http://comicneue.com/>`_
238+
* the font "Times New Roman"
239+
240+
..note::
241+
242+
The documentation will not build without LaTeX and Graphviz. These are not
243+
Python packages and must be installed separately. The documentation can be
244+
built without Inkscape and optipng, but the build process will raise various
245+
warnings. If the build process warns that you are missing fonts, make sure
246+
your LaTeX distribution bundles cm-super or install it separately.

‎doc/devel/development_setup.rst

Lines changed: 2 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -60,76 +60,6 @@ true for ``*.py`` files. If you change the C-extension source (which might
6060
also happen if you change branches) you will have to re-run
6161
``python -m pip install -ve .``
6262

63-
.. _test-dependencies:
64-
65-
Additional dependencies for testing
66-
===================================
67-
This section lists the additional software required for
68-
:ref:`running the tests<testing>`.
69-
70-
Required:
71-
72-
-pytest_ (>=3.6)
73-
-Ghostscript_ (>= 9.0, to render PDF files)
74-
-Inkscape_ (to render SVG files)
75-
76-
Optional:
77-
78-
-pytest-cov_ (>=2.3.1) to collect coverage information
79-
-pytest-flake8_ to test coding standards usingflake8_
80-
-pytest-timeout_ to limit runtime in case of stuck tests
81-
-pytest-xdist_ to run tests in parallel
82-
83-
.. _pytest:http://doc.pytest.org/en/latest/
84-
.. _Ghostscript:https://www.ghostscript.com/
85-
.. _Inkscape:https://inkscape.org
86-
.. _pytest-cov:https://pytest-cov.readthedocs.io/en/latest/
87-
.. _pytest-flake8:https://pypi.org/project/pytest-flake8/
88-
.. _pytest-xdist:https://pypi.org/project/pytest-xdist/
89-
.. _pytest-timeout:https://pypi.org/project/pytest-timeout/
90-
.. _flake8:https://pypi.org/project/flake8/
91-
92-
93-
.. _doc-dependencies:
94-
95-
Additional dependencies for building documentation
63+
Installing additional dependencies for development
9664
==================================================
97-
98-
Python packages
99-
---------------
100-
The additional Python packages required to build the
101-
:ref:`documentation<documenting-matplotlib>` are listed in
102-
:file:`doc-requirements.txt` and can be installed using ::
103-
104-
pip install -r requirements/doc/doc-requirements.txt
105-
106-
The content of:file:`doc-requirements.txt` is also shown below:
107-
108-
..include::../../requirements/doc/doc-requirements.txt
109-
:literal:
110-
111-
Additional external dependencies
112-
--------------------------------
113-
Required:
114-
115-
* a minimal working LaTeX distribution
116-
* `Graphviz<http://www.graphviz.org/download>`_
117-
* the LaTeX packages *cm-super* and *dvipng* (if your OS bundles TeXLive, the
118-
"complete" version of the installer, e.g. "texlive-full" or "texlive-all",
119-
will often automatically include these packages)
120-
121-
Optional, but recommended:
122-
123-
* `Inkscape<https://inkscape.org>`_
124-
* `optipng<http://optipng.sourceforge.net>`_
125-
* the font "Humor Sans" (aka the "XKCD" font), or the free alternative
126-
`Comic Neue<http://comicneue.com/>`_
127-
* the font "Times New Roman"
128-
129-
..note::
130-
131-
The documentation will not build without LaTeX and Graphviz. These are not
132-
Python packages and must be installed separately. The documentation can be
133-
built without Inkscape and optipng, but the build process will raise various
134-
warnings. If the build process warns that you are missing fonts, make sure
135-
your LaTeX distribution bundles cm-super or install it separately.
65+
See:ref:`development-dependencies`.

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp