|
3 | 3 | API Changes |
4 | 4 | =========== |
5 | 5 |
|
6 | | -A log of changes to the most recent version of Matplotlib that affect the |
7 | | -outward-facing API. If updating Matplotlib breaks your scripts, this list may |
8 | | -help you figure out what caused the breakage and how to fix it by updating |
9 | | -your code. For API changes in older versions see :doc:`api_changes_old`. |
| 6 | +If updating Matplotlib breaks your scripts, this list may help you figure out |
| 7 | +what caused the breakage and how to fix it by updating your code. |
10 | 8 |
|
11 | | -For new features that were added to Matplotlib, see :ref:`whats-new`. |
12 | | - |
13 | | -This pages lists API changes for the most recent version of Matplotlib. |
| 9 | +For API changes in older versions see |
14 | 10 |
|
15 | 11 | .. toctree:: |
16 | 12 | :maxdepth: 1 |
17 | 13 |
|
18 | 14 | api_changes_old |
19 | 15 |
|
| 16 | +Changes for the latest version are listed below. For new features that were |
| 17 | +added to Matplotlib, see :ref:`whats-new`. |
20 | 18 |
|
21 | | -.. note:: |
| 19 | +.. ifconfig:: releaselevel == 'dev' |
22 | 20 |
|
23 | | - The list below is a table of contents of individual files from the |
24 | | - 'next_api_changes' folder. |
| 21 | + .. note:: |
25 | 22 |
|
26 | | - When a release is made |
| 23 | + The list below is a table of contents of individual files from the |
| 24 | + 'next_api_changes' folder. |
27 | 25 |
|
28 | | - - The full text list below should be moved into its own file in |
29 | | - 'prev_api_changes' |
30 | | - - All the files in 'next_api_changes' should be moved to the bottom of this page |
31 | | - - This note, and the toctree below should be commented out |
| 26 | + When a release is made |
32 | 27 |
|
| 28 | + - All the files in 'next_api_changes/' should be moved to a single file in |
| 29 | + 'prev_api_changes/'. |
| 30 | + - The include directive below should be changed to point to the new file |
| 31 | + created in the previous step. |
| 32 | + - This note, and the toctree below should be commented out. |
33 | 33 |
|
34 | | -.. toctree:: |
35 | | - :glob: |
36 | | - :maxdepth: 1 |
37 | 34 |
|
38 | | - next_api_changes/* |
| 35 | + .. toctree:: |
| 36 | + :glob: |
| 37 | + :maxdepth: 1 |
| 38 | + |
| 39 | + next_api_changes/* |
| 40 | + |
| 41 | +.. include:: prev_api_changes/api_changes_3.1.0.rst |
0 commit comments