Skip to content

Doc rearrange relnotes #21027

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 91 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
91 commits
Select commit Hold shift + click to select a range
5821a24
API: rename draw_no_output to draw_without_rendering
tacaswell Aug 28, 2021
1a9f0a2
DOC: re-word the whats new entry
tacaswell Aug 28, 2021
5a58788
Support sketch_params in pgf backend
takimata Jun 25, 2021
f67e604
Fix docstring
takimata Jun 25, 2021
92e9fb6
Add test
takimata Jun 30, 2021
c2ef020
Clarify stuff
takimata Jul 1, 2021
9d73118
Fix rendering of code block
takimata Jul 23, 2021
b94b282
Automatically load PGF components
takimata Jul 23, 2021
18c06c3
Scale params to match existing appearance
takimata Aug 22, 2021
a9377cd
Use descriptive names
takimata Aug 24, 2021
c3503a2
Fix comment length
takimata Aug 25, 2021
3263061
Merge pull request #20944 from anntzer/mtd
QuLogic Aug 30, 2021
124ba6e
DOC: re-word whats new
tacaswell Aug 31, 2021
6d56592
Merge pull request #20931 from tacaswell/api_rename_draw_no_output
timhoffm Aug 31, 2021
ceb794c
Merge pull request #20956 from anntzer/lhu
timhoffm Sep 1, 2021
b5058a5
Merge pull request #20955 from anntzer/glh
timhoffm Sep 1, 2021
bb12efe
Merge pull request #20952 from dstansby/3rd-party-redirect
QuLogic Sep 1, 2021
6683517
Merge pull request #20957 from anntzer/lhm
dstansby Sep 1, 2021
a142369
Merge pull request #20745 from QuLogic/event-docs
dstansby Sep 1, 2021
f023115
Small cleanups to math_to_image.
anntzer Sep 1, 2021
486ad06
BUG: Fix f_back is None handling
larsoner Sep 1, 2021
0b724bf
Add a GTK4 backend.
QuLogic Jul 31, 2021
139a4db
Move common GTK Backend code into a separate file.
QuLogic Aug 4, 2021
e135227
Combine common GTK timer code.
QuLogic Aug 4, 2021
1d6fd65
Combine common GTK toolbar code.
QuLogic Aug 5, 2021
68b4ee3
Clean up calls to Gtk.Window.set_icon_from_file.
QuLogic Aug 5, 2021
7b63dee
Add GTK4 to docs.
QuLogic Aug 6, 2021
d3804c2
Fix Ctrl+C out of IPython on GTK4.
QuLogic Aug 19, 2021
72f7595
Merge pull request #19553 from greglucas/norm-updater
tacaswell Sep 1, 2021
2e31b07
Merge pull request #20965 from larsoner/fback
QuLogic Sep 1, 2021
0a9007c
Merge pull request #20961 from anntzer/mti
dstansby Sep 1, 2021
d3da54a
Merge pull request #20321 from QuLogic/gtk4
QuLogic Sep 1, 2021
3eeae5b
Build wheels for Apple Silicon.
QuLogic Sep 2, 2021
fafe155
Merge pull request #20970 from QuLogic/m1-wheel
story645 Sep 2, 2021
640f96d
Cleanup some dviread docstrings.
anntzer Sep 2, 2021
3d7c92c
Docstring cleanups.
anntzer Sep 2, 2021
a1c69dd
Rename symbol_name to glyph_name where appropriate.
anntzer Sep 2, 2021
039c94a
Merge pull request #20973 from anntzer/d401
story645 Sep 2, 2021
75710ed
Clarify support for 2D coordinate inputs to streamplot.
anntzer Sep 2, 2021
8e400d8
Merge pull request #20975 from anntzer/s2d
timhoffm Sep 2, 2021
2a1075b
Merge pull request #20972 from anntzer/dd
timhoffm Sep 2, 2021
4e21dcf
Merge pull request #20942 from timhoffm/doc-axes-capitalization
timhoffm Sep 2, 2021
5656d11
Merge pull request #20974 from anntzer/gn
QuLogic Sep 2, 2021
f23fd1f
Make HandlerLine2D{,Compound} inherit constructors from HandlerNpoints.
anntzer Sep 3, 2021
a6221ed
Merge pull request #20986 from anntzer/lhhl
story645 Sep 3, 2021
f41edb6
FIX: colorbar with boundary norm, proportional, extend
jklymak Sep 4, 2021
6134061
Remove unused icon_filename, window_icon globals.
anntzer Sep 4, 2021
4dd72b9
Deprecate some backend_gtk3 helper globals.
anntzer Sep 4, 2021
72c728c
Fix ToolManager + TextBox support.
anntzer Sep 4, 2021
3361895
Merge pull request #20997 from anntzer/tmtb
timhoffm Sep 4, 2021
8ce14fb
Merge pull request #20987 from jklymak/fix-colorbar-boundary-extend
timhoffm Sep 5, 2021
1586fb5
Remove now-unused rcParams _deprecated entries.
anntzer Sep 6, 2021
f7622b6
Test the rcParams deprecation machinery.
anntzer Sep 6, 2021
162f688
Deemphasize mpl_toolkits in API docs.
anntzer Sep 5, 2021
481da9b
Separate tick and spine examples
dstansby Sep 7, 2021
cb17118
Merge pull request #21003 from anntzer/dtk
timhoffm Sep 7, 2021
79a29b6
Use numpydoc for GridSpecFromSubplotSpec.__init__
dstansby Sep 7, 2021
c4412e7
Merge pull request #21004 from anntzer/da
QuLogic Sep 7, 2021
7f89450
Merge pull request #20995 from anntzer/g3i
QuLogic Sep 7, 2021
d37075f
Merge pull request #21012 from dstansby/GridSpecFromSubplotSpec-doc
QuLogic Sep 7, 2021
8f62645
Merge pull request #20994 from anntzer/g4i
QuLogic Sep 7, 2021
308d2ac
Avoid TransformedBbox where unneeded.
anntzer Sep 7, 2018
3d7a46e
Merge pull request #20976 from dstansby/tick-spine-exs
timhoffm Sep 8, 2021
961a92c
Reword custom_ticker1 example.
anntzer Sep 8, 2021
39c5302
Merge pull request #21019 from anntzer/ct1
jklymak Sep 8, 2021
87bae58
Merge pull request #21010 from anntzer/ntb
dstansby Sep 8, 2021
971d110
Merge pull request #21005 from anntzer/rdmt
jklymak Sep 8, 2021
ce9a7b1
Merge pull request #20518 from takimata/pgf_sketch_path
tacaswell Sep 8, 2021
2d2cbe0
DOC: re-arrange user's guide and index
tacaswell Aug 15, 2021
8d8674c
DOC: add direct Matplotlib sponsorship to sponsor button
tacaswell Aug 20, 2021
ccf6270
DOC: split the user-guide into parts
tacaswell Aug 20, 2021
6339e69
DOC: add search bar back to inner index
tacaswell Aug 22, 2021
6598304
ENH: require sphinx-panels to build the docs
tacaswell Aug 22, 2021
0e00c50
DOC: add release notes to top bar
tacaswell Aug 22, 2021
6a91938
DOC: move installation out of top bar and onto inner index
tacaswell Aug 22, 2021
a1c2d0d
DOC: try to make the left sidebar on inner index better
tacaswell Aug 22, 2021
81002d0
DOC: put documentation types in a 2x2 grid
tacaswell Aug 22, 2021
8eb0192
DOC: rename user's guide -> user guide
tacaswell Aug 22, 2021
0d62f09
DOC: move detailed installation to user guide
tacaswell Aug 22, 2021
3839c5b
DOC: suggestions from review
tacaswell Aug 24, 2021
1c77a1b
STY: flake8 in conf.py
tacaswell Aug 24, 2021
f779ea6
STY: fix section capitalization
tacaswell Aug 24, 2021
50d41c5
DOC: continue to shuffle things around to placate the TOC
tacaswell Aug 24, 2021
769b3b7
DOC: add link to contents to index page
tacaswell Aug 24, 2021
2d599a8
DOC: tweaks to content / layout of inner index
tacaswell Aug 24, 2021
887be7b
DOC: add note about wheels
tacaswell Aug 24, 2021
965ef4d
DOC: hide the next/prev buttons
tacaswell Aug 24, 2021
4a892b7
DOC: add (but do not enable) external link to third-party page
tacaswell Aug 24, 2021
6d6ce6b
DOC: re-arrange contents.rst and top navbar
tacaswell Sep 4, 2021
daffe46
DOC: push up sphinx-pydata-theme dependency
tacaswell Sep 4, 2021
399fe22
DOC: re-arrange the release notes toctrees
tacaswell Aug 20, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions .flake8
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,15 @@ per-file-ignores =
examples/style_sheets/plot_solarizedlight2.py: E501
examples/subplots_axes_and_figures/demo_constrained_layout.py: E402
examples/text_labels_and_annotations/custom_legends.py: E402
examples/ticks_and_spines/date_concise_formatter.py: E402
examples/ticks/date_concise_formatter.py: E402
examples/user_interfaces/embedding_in_gtk3_panzoom_sgskip.py: E402
examples/user_interfaces/embedding_in_gtk3_sgskip.py: E402
examples/user_interfaces/gtk_spreadsheet_sgskip.py: E402
examples/user_interfaces/embedding_in_gtk4_panzoom_sgskip.py: E402
examples/user_interfaces/embedding_in_gtk4_sgskip.py: E402
examples/user_interfaces/gtk3_spreadsheet_sgskip.py: E402
examples/user_interfaces/gtk4_spreadsheet_sgskip.py: E402
examples/user_interfaces/mpl_with_glade3_sgskip.py: E402
examples/user_interfaces/pylab_with_gtk_sgskip.py: E402
examples/user_interfaces/pylab_with_gtk3_sgskip.py: E402
examples/user_interfaces/pylab_with_gtk4_sgskip.py: E402
examples/user_interfaces/toolmanager_sgskip.py: E402
examples/userdemo/pgf_preamble_sgskip.py: E402
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# These are supported funding model platforms
github: [numfocus]
github: [matplotlib, numfocus]
custom: https://numfocus.org/donate-to-matplotlib
1 change: 1 addition & 0 deletions .github/workflows/cibuildwheel.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ jobs:
env:
min-numpy-version: "1.17.3"
min-numpy-hash: "b6/d6/be8f975f5322336f62371c9abeb936d592c98c047ad63035f1b38ae08efe"
CIBW_ARCHS_MACOS: "x86_64 universal2 arm64"
strategy:
matrix:
os: [ubuntu-18.04, windows-latest, macos-latest]
Expand Down
8 changes: 8 additions & 0 deletions doc/_static/mpl.css
Original file line number Diff line number Diff line change
Expand Up @@ -212,3 +212,11 @@ table.property-table th,
table.property-table td {
padding: 4px 10px;
}

.donate-button {
margin: 1em 0;
}

.sphinxsidebarwrapper {
margin: 0 1em;
}
9 changes: 9 additions & 0 deletions doc/_templates/cheatsheet_sidebar.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

<div class="sphinxsidebarwrapper">
<h3>Matplotlib cheatsheets</h3>
<a href="https://github.com/matplotlib/cheatsheets#cheatsheets">
<img src="_static/mpl_cheatsheet1.png"
alt="Matplotlib cheatsheets"
srcset="_static/mpl_cheatsheet1.png 1x, _static/mpl_cheatsheet1_2x.png 2x"/>
</a>
</div>
6 changes: 4 additions & 2 deletions doc/_templates/donate_sidebar.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@



<div id="sidebar-donations">
<a href="https://numfocus.org/donate-to-matplotlib" target="_blank"> <span class="mpl-button donate_button" >Support Matplotlib</span></a>
<div id="sidebar-donations" class="donate-button">
<a href="https://numfocus.org/donate-to-matplotlib" target="_blank">
<span class="mpl-button" >Support Matplotlib</span>
</a>
</div>
24 changes: 24 additions & 0 deletions doc/_templates/mpl_nav_bar.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<ul id="navbar-main-elements" class="navbar-nav">

<li class="nav-item">
<a class="reference internal nav-link" href="{{ pathto('plot_types/index') }}">Plot Types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="{{ pathto('gallery/index') }}">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="{{ pathto('tutorials/index') }}">Tutoraials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="{{ pathto('api/index') }}">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="{{ pathto('contents') }}">Usage Guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="{{ pathto('devel/index') }}">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="{{ pathto('users/release_notes') }}">Release Notes</a>
</li>
</ul>
9 changes: 0 additions & 9 deletions doc/_templates/sidebar_versions.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,3 @@
getSnippet('other_versions', '/versions.html');
</script>
</div>

<div class="sphinxsidebarwrapper">
<h3>Matplotlib cheatsheets</h3>
<a href="https://github.com/matplotlib/cheatsheets#cheatsheets">
<img src="_static/mpl_cheatsheet1.png"
alt="Matplotlib cheatsheets"
srcset="_static/mpl_cheatsheet1.png 1x, _static/mpl_cheatsheet1_2x.png 2x"/>
</a>
</div>
16 changes: 16 additions & 0 deletions doc/api/backend_gtk4_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
**NOTE** These backends are not documented here, to avoid adding a dependency
to building the docs.

.. redirect-from:: /api/backend_gtk4agg_api
.. redirect-from:: /api/backend_gtk4cairo_api


:mod:`matplotlib.backends.backend_gtk4agg`
==========================================

.. module:: matplotlib.backends.backend_gtk4agg

:mod:`matplotlib.backends.backend_gtk4cairo`
============================================

.. module:: matplotlib.backends.backend_gtk4cairo
15 changes: 0 additions & 15 deletions doc/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,21 +101,6 @@ Alphabetical list of modules:
widgets_api.rst
_api_api.rst
_enums_api.rst

Toolkits
--------

:ref:`toolkits-index` are collections of application-specific functions that extend
Matplotlib. The following toolkits are included:

.. toctree::
:hidden:

toolkits/index.rst

.. toctree::
:maxdepth: 1

toolkits/mplot3d.rst
toolkits/axes_grid1.rst
toolkits/axisartist.rst
Expand Down
1 change: 1 addition & 0 deletions doc/api/index_backend_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
backend_agg_api.rst
backend_cairo_api.rst
backend_gtk3_api.rst
backend_gtk4_api.rst
backend_nbagg_api.rst
backend_pdf_api.rst
backend_pgf_api.rst
Expand Down
3 changes: 3 additions & 0 deletions doc/api/next_api_changes/deprecations/20995-AL.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
``backend_gtk3.icon_filename`` and ``backend_gtk3.window_icon``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
... are deprecated with no replacement.
46 changes: 0 additions & 46 deletions doc/api/toolkits/index.rst

This file was deleted.

32 changes: 28 additions & 4 deletions doc/api/toolkits/mplot3d.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,32 @@
.. _toolkit_mplot3d-api:
.. _toolkit_mplot3d-index:
.. currentmodule:: mpl_toolkits.mplot3d

************************
``mpl_toolkits.mplot3d``
************************

The mplot3d toolkit adds simple 3D plotting capabilities (scatter, surface,
line, mesh, etc.) to Matplotlib by supplying an Axes object that can create
a 2D projection of a 3D scene. The resulting graph will have the same look
and feel as regular 2D plots. Not the fastest or most feature complete 3D
library out there, but it ships with Matplotlib and thus may be a lighter
weight solution for some use cases.

See the :doc:`mplot3d tutorial </tutorials/toolkits/mplot3d>` for
more information.

.. image:: /_static/demo_mplot3d.png
:align: center

The interactive backends also provide the ability to rotate and zoom the 3D
scene. One can rotate the 3D scene by simply clicking-and-dragging the scene.
Zooming is done by right-clicking the scene and dragging the mouse up and down
(unlike 2D plots, the toolbar zoom button is not used).

.. toctree::
:maxdepth: 2

***********
mplot3d API
***********
mplot3d/faq.rst

.. note::
`.pyplot` cannot be used to add content to 3D plots, because its function
Expand Down
28 changes: 0 additions & 28 deletions doc/api/toolkits/mplot3d/index.rst

This file was deleted.

14 changes: 13 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,15 @@
'sphinxext.skip_deprecated',
'sphinxext.redirect_from',
'sphinx_copybutton',
'sphinx_panels',
]

exclude_patterns = [
'api/prev_api_changes/api_changes_*/*',
]

panels_add_bootstrap_css = False


def _check_dependencies():
names = {
Expand Down Expand Up @@ -291,6 +294,12 @@ def _check_dependencies():
html_theme_options = {
"logo_link": "index",
"collapse_navigation": True if CIRCLECI else False,
# "external_links": [
# {
# "name": "Third party packages",
# "url": "https://matplotlib.org/mpl-third-party/"
# },
# ],
"icon_links": [
{
"name": "gitter",
Expand All @@ -312,8 +321,9 @@ def _check_dependencies():
"url": "https://twitter.com/matplotlib/",
"icon": "fab fa-twitter-square",
},

],
"show_prev_next": False,
"navbar_center": ["mpl_nav_bar.html"],
}
include_analytics = False
if include_analytics:
Expand Down Expand Up @@ -341,8 +351,10 @@ def _check_dependencies():
# Custom sidebar templates, maps page names to templates.
html_sidebars = {
"index": [
'search-field.html',
# 'sidebar_announcement.html',
"sidebar_versions.html",
"cheatsheet_sidebar.html",
"donate_sidebar.html",
],
# '**': ['localtoc.html', 'pagesource.html']
Expand Down
9 changes: 3 additions & 6 deletions doc/contents.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

.. _complete_sitemap:

Contents
========
Expand All @@ -15,13 +15,10 @@ Contents
:maxdepth: 2

users/installing.rst
plot_types/index.rst
gallery/index.rst
tutorials/index.rst
api/index.rst
users/index.rst
users/backmatter.rst
devel/index.rst
Third-party packages <https://matplotlib.org/mpl-third-party/>
users/release_notes.rst

.. only:: html

Expand Down
4 changes: 2 additions & 2 deletions doc/devel/dependencies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ and the capabilities they provide.

* Tk_ (>= 8.4, != 8.6.0 or 8.6.1) [#]_: for the Tk-based backends.
* PyQt6_ (>= 6.1), PySide6_, PyQt5_, or PySide2_: for the Qt-based backends.
* PyGObject_: for the GTK3-based backends [#]_.
* PyGObject_: for the GTK-based backends [#]_.
* wxPython_ (>= 4) [#]_: for the wx-based backends.
* pycairo_ (>= 1.11.0) or cairocffi_ (>= 0.8): for the GTK3 and/or cairo-based
* pycairo_ (>= 1.11.0) or cairocffi_ (>= 0.8): for the GTK and/or cairo-based
backends.
* Tornado_: for the WebAgg backend.

Expand Down
2 changes: 1 addition & 1 deletion doc/devel/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ The correct target folder can be found using::
python -c "import matplotlib.tests; print(matplotlib.tests.__file__.rsplit('/', 1)[0])"

An analogous copying of :file:`lib/mpl_toolkits/tests/baseline_images`
is necessary for testing the :ref:`toolkits`.
is necessary for testing ``mpl_toolkits``.

Run the tests
^^^^^^^^^^^^^
Expand Down
6 changes: 3 additions & 3 deletions doc/faq/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _faq-index:

##################
The Matplotlib FAQ
##################
######
How-To
######

.. only:: html

Expand Down
Loading