File tree Expand file tree Collapse file tree 3 files changed +27
-14
lines changed
Filter options
Expand file tree Collapse file tree 3 files changed +27
-14
lines changed
Original file line number Diff line number Diff line change 11:orphan:
22
3+ .. NOTE TO EDITORS OF THIS FILE
4+ This file serves as README directly available in the file system next to the
5+ next_api_changes entries. Its 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
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+ :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
3341confusing in the table of contents. Instead, ensure that a reference is
3442included 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
Original file line number Diff line number Diff 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
224224What'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
Original file line number Diff line number Diff line change 11:orphan:
22
3+ .. NOTE TO EDITORS OF THIS FILE
4+ This file serves as README directly available in the file system next to the
5+ next_whats_new entries. Its content, between the ``whats-new-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+
9+
310
411=============================================
512
6- Please place new portions of :file: `whats_new.rst ` in the :file: `next_whats_new `
7- directory.
13+ .. whats-new-guide-start
14+
15+ :file: `whats_new.rst ` in the
16+ :file: `doc/users/next_whats_new/ ` directory.
817
918When adding an entry please look at the currently existing files to
1019see if you can extend any of them. If you create a file, name it
@@ -27,6 +36,4 @@ Please avoid using references in section titles, as it causes links to be
2736confusing in the table of contents. Instead, ensure that a reference is
2837included in the descriptive text.
2938
30- .. NOTE
31- Lines 5-24 of this file are include in :ref:`api_whats_new`;
32- therefore, please check the doc build after changing this file.
39+ .. whats-new-guide-end
You can’t perform that action at this time.
0 commit comments