Skip to content

Commit 8125ca1

Browse files
committed
DOC: Fix inclusion of next API/what's new instructions
1 parent a679148 commit 8125ca1

File tree

3 files changed

+10
-12
lines changed

3 files changed

+10
-12
lines changed

doc/api/next_api_changes/README.rst

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

3+
.. NOTE
4+
Lines 9-end of this file are include in :ref:`api_whats_new`;
5+
therefore, please check the doc build after changing this file.
6+
37
Adding API change notes
48
=======================
59

@@ -32,7 +36,3 @@ A typical entry could look like this::
3236
Please avoid using references in section titles, as it causes links to be
3337
confusing in the table of contents. Instead, ensure that a reference is
3438
included in the descriptive text.
35-
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.

doc/devel/api_changes.rst

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

218218
.. include:: ../api/next_api_changes/README.rst
219-
:start-line: 5
220-
:end-line: 31
219+
:start-line: 9
221220

222221
.. _whats-new-notes:
223222

224223
What's new notes
225224
""""""""""""""""
226225

227226
.. include:: ../users/next_whats_new/README.rst
228-
:start-line: 5
229-
:end-line: 24
227+
:start-line: 9

doc/users/next_whats_new/README.rst

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

3+
.. NOTE
4+
Lines 9-end of this file are include in :ref:`api_whats_new`;
5+
therefore, please check the doc build after changing this file.
6+
37
Instructions for writing "What's new" entries
48
=============================================
59

@@ -26,7 +30,3 @@ Include contents of the form::
2630
Please avoid using references in section titles, as it causes links to be
2731
confusing in the table of contents. Instead, ensure that a reference is
2832
included in the descriptive text.
29-
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.

0 commit comments

Comments
 (0)