8000 Merge branch 'main' into axesbase_twinx_type_hint · matplotlib/matplotlib@182f468 · GitHub
[go: up one dir, main page]
Skip to content
Sign in

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
Appearance settings

Commit 182f468

Browse files
randolf-scholzrandolf-scholz
committed
Merge branch 'main' into axesbase_twinx_type_hint
2 parents a39580e + f7b3def commit 182f468

File tree

17 files changed

+262
-294
lines changed

17 files changed

+262
-294
lines changed

‎doc/_templates/autofunctions.rst

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

‎doc/api/next_api_changes.rst

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,40 @@ Next API changes
55

66
.. ifconfig:: releaselevel == 'dev'
77

8+
This page lists API changes for the next release.
9+
10+
Behavior changes
11+
----------------
12+
813
.. toctree::
914
:glob:
1015
:maxdepth: 1
1116

1217
next_api_changes/behavior/*
18+
19+
Deprecations
20+
------------
21+
22+
.. toctree::
23+
:glob:
24+
:maxdepth: 1
25+
1326
next_api_changes/deprecations/*
14-
next_api_changes/development/*
27+
28+
Removals
29+
--------
30+
31+
.. toctree::
32+
:glob:
33+
:maxdepth: 1
34+
1535
next_api_changes/removals/*
36+
37+
Development changes
38+
-------------------
39+
40+
.. toctree::
41+
:glob:
42+
:maxdepth: 1
43+
44+
next_api_changes/development/*

‎doc/api/next_api_changes/README.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
:orphan:
22

3+
.. NOTE TO EDITORS OF THIS FILE
4+
This file serves as the README directly available in the file system next to the
5+
next_api_changes entries. The content between the ``api-change-guide-*`` markers is
6+
additionally included in the documentation page ``doc/devel/api_changes.rst``. Please
7+
check that the page builds correctly after changing this file.
8+
39
Adding API change notes
410
=======================
511

6-
API change notes for future releases are collected in
7-
:file:`next_api_changes`. They are divided into four subdirectories:
12+
.. api-change-guide-start
13+
14+
API change notes for future releases are collected in :file:`doc/api/next_api_changes/`.
15+
They are divided into four subdirectories:
816

917
- **Deprecations**: Announcements of future changes. Typically, these will
1018
raise a deprecation warning and users of this API should change their code
@@ -33,6 +41,4 @@ Please avoid using references in section titles, as it causes links to be
3341
confusing in the table of contents. Instead, ensure that a reference is
3442
included in the descriptive text.
3543

36-
.. NOTE
37-
Lines 5-30 of this file are include in :ref:`api_whats_new`;
38-
therefore, please check the doc build after changing this file.
44+
.. api-change-guide-end

‎doc/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -360,8 +360,8 @@ def gallery_image_warning_filter(record):
360360
# This is the default encoding, but it doesn't hurt to be explicit
361361
source_encoding = "utf-8"
362362

363-
# The toplevel toctree document (renamed to root_doc in Sphinx 4.0)
364-
root_doc = master_doc = 'index'
363+
# The toplevel toctree document.
364+
root_doc = 'index'
365365

366366
# General substitutions.
367367
try:

‎doc/devel/api_changes.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -216,14 +216,14 @@ API change notes
216216
""""""""""""""""
217217

218218
.. include:: ../api/next_api_changes/README.rst
219-
:start-line: 5
220-
:end-line: 31
219+
:start-after: api-change-guide-start
220+
:end-before: api-change-guide-end
221221

222222
.. _whats-new-notes:
223223

224224
What's new notes
225225
""""""""""""""""
226226

227227
.. include:: ../users/next_whats_new/README.rst
228-
:start-line: 5
229-
:end-line: 24
228+
:start-after: whats-new-guide-start
229+
:end-before: whats-new-guide-end

0 commit comments

Comments
 (0)
0