Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 224b680

Browse files
QuLogicQuLogic
authored
Merge pull request #21804 from QuLogic/pdf-35x
Backport PR #21659 on branch v3.5.x (Fix PDF contents)
2 parents c0bb31e + 83bb501 commit 224b680

File tree

8 files changed

+322
-331
lines changed

8 files changed

+322
-331
lines changed

‎INSTALL.rst‎

Lines changed: 1 addition & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,91 +1 @@
1-
############
2-
Installation
3-
############
4-
5-
==============================
6-
Installing an official release
7-
==============================
8-
9-
Matplotlib releases are available as wheel packages for macOS, Windows and
10-
Linux on `PyPI <https://pypi.org/project/matplotlib/>`_. Install it using
11-
``pip``:
12-
13-
.. code-block:: sh
14-
15-
python -m pip install -U pip
16-
python -m pip install -U matplotlib
17-
18-
If this command results in Matplotlib being compiled from source and
19-
there's trouble with the compilation, you can add ``--prefer-binary`` to
20-
select the newest version of Matplotlib for which there is a
21-
precompiled wheel for your OS and Python.
22-
23-
.. note::
24-
25-
The following backends work out of the box: Agg, ps, pdf, svg
26-
27-
Python is typically shipped with tk bindings which are used by
28-
TkAgg.
29-
30-
For support of other GUI frameworks, LaTeX rendering, saving
31-
animations and a larger selection of file formats, you can
32-
install :ref:`optional_dependencies`.
33-
34-
=========================
35-
Third-party distributions
36-
=========================
37-
38-
Various third-parties provide Matplotlib for their environments.
39-
40-
Conda packages
41-
==============
42-
Matplotlib is available both via the *anaconda main channel*
43-
44-
.. code-block:: sh
45-
46-
conda install matplotlib
47-
48-
as well as via the *conda-forge community channel*
49-
50-
.. code-block:: sh
51-
52-
conda install -c conda-forge matplotlib
53-
54-
Python distributions
55-
====================
56-
57-
Matplotlib is part of major Python distributions:
58-
59-
- `Anaconda <https://www.anaconda.com/>`_
60-
61-
- `ActiveState ActivePython
62-
<https://www.activestate.com/products/python/downloads/>`_
63-
64-
- `WinPython <https://winpython.github.io/>`_
65-
66-
Linux package manager
67-
=====================
68-
69-
If you are using the Python version that comes with your Linux distribution,
70-
you can install Matplotlib via your package manager, e.g.:
71-
72-
* Debian / Ubuntu: ``sudo apt-get install python3-matplotlib``
73-
* Fedora: ``sudo dnf install python3-matplotlib``
74-
* Red Hat: ``sudo yum install python3-matplotlib``
75-
* Arch: ``sudo pacman -S python-matplotlib``
76-
77-
======================
78-
Installing from source
79-
======================
80-
See :ref:`install_from_source`.
81-
82-
==========================
83-
Installing for development
84-
==========================
85-
See :ref:`installing_for_devs`.
86-
87-
==============
88-
Installing FAQ
89-
==============
90-
91-
See :ref:`installing-faq`.
1+
See doc/users/installing/index.rst

‎README.rst‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,9 @@ various graphical user interface toolkits.
5858
Install
5959
=======
6060

61-
For installation instructions and requirements, see `INSTALL.rst <INSTALL.rst>`_ or the
62-
`install <https://matplotlib.org/stable/users/installing.html>`_ documentation.
61+
For installation instructions and requirements, see the `install documentation
62+
<https://matplotlib.org/stable/users/installing/index.html>`_ or
63+
`installing.rst <doc/users/installing/index.rst>`_ in the source.
6364

6465
Contribute
6566
==========

‎doc/conf.py‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -212,8 +212,8 @@ def _check_dependencies():
212212
# This is the default encoding, but it doesn't hurt to be explicit
213213
source_encoding = "utf-8"
214214

215-
# The master toctree document.
216-
master_doc = 'users/index'
215+
# The toplevel toctree document (renamed to root_doc in Sphinx 4.0)
216+
root_doc = master_doc = 'users/index'
217217

218218
# General substitutions.
219219
try:
@@ -378,7 +378,7 @@ def _check_dependencies():
378378
# document class [howto/manual])
379379

380380
latex_documents = [
381-
('contents', 'Matplotlib.tex', 'Matplotlib',
381+
(root_doc, 'Matplotlib.tex', 'Matplotlib',
382382
'John Hunter\\and Darren Dale\\and Eric Firing\\and Michael Droettboom'
383383
'\\and and the matplotlib development team', 'manual'),
384384
]
@@ -461,6 +461,8 @@ def _check_dependencies():
461461

462462
# Additional stuff for the LaTeX preamble.
463463
latex_elements['preamble'] = r"""
464+
% Show Parts and Chapters in Table of Contents
465+
\setcounter{tocdepth}{0}
464466
% One line per author on title page
465467
\DeclareRobustCommand{\and}%
466468
{\end{tabular}\kern-\tabcolsep\\\begin{tabular}[t]{c}}%
@@ -508,7 +510,7 @@ def _check_dependencies():
508510
autoclass_content = 'both'
509511

510512
texinfo_documents = [
511-
("contents", 'matplotlib', 'Matplotlib Documentation',
513+
(root_doc, 'matplotlib', 'Matplotlib Documentation',
512514
'John Hunter@*Darren Dale@*Eric Firing@*Michael Droettboom@*'
513515
'The matplotlib development team',
514516
'Matplotlib', "Python plotting package", 'Programming',

‎doc/devel/documenting_mpl.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -197,22 +197,22 @@ Documents can be linked with the ``:doc:`` directive:
197197

198198
.. code-block:: rst
199199
200-
See the :doc:`/users/faq/installing_faq`
200+
See the :doc:`/users/installing/index`
201201
202202
See the tutorial :doc:`/tutorials/introductory/usage`
203203
204204
See the example :doc:`/gallery/lines_bars_and_markers/simple_plot`
205205
206206
will render as:
207207

208-
See the :doc:`/users/faq/installing_faq`
208+
See the :doc:`/users/installing/index`
209209

210210
See the tutorial :doc:`/tutorials/introductory/usage`
211211

212212
See the example :doc:`/gallery/lines_bars_and_markers/simple_plot`
213213

214214
Sections can also be given reference names. For instance from the
215-
:doc:`/users/faq/installing_faq` link:
215+
:doc:`/users/installing/index` link:
216216

217217
.. code-block:: rst
218218

‎doc/users/faq/installing_faq.rst‎

Lines changed: 0 additions & 139 deletions
This file was deleted.

‎doc/users/index.rst‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,6 @@
77
Users guide
88
###########
99

10-
Tutorials and examples
11-
######################
12-
13-
.. toctree::
14-
:maxdepth: 1
15-
16-
../plot_types/index.rst
17-
../tutorials/index.rst
18-
../gallery/index.rst
19-
2010
General
2111
#######
2212

@@ -29,6 +19,16 @@ General
2919
faq/index.rst
3020
resources/index.rst
3121

22+
Tutorials and examples
23+
######################
24+
25+
.. toctree::
26+
:maxdepth: 1
27+
28+
../plot_types/index.rst
29+
../tutorials/index.rst
30+
../gallery/index.rst
31+
3232
Reference
3333
#########
3434

0 commit comments

Comments
 (0)