Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit a3ec850

Browse files
committed
DOC: add orphan tag to next_*/README.rst to quiet sphinx warnings
1 parent 99728aa commit a3ec850

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

doc/api/next_api_changes/README.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
1+
:orphan:
2+
13
Adding API change notes
2-
```````````````````````
4+
=======================
35

6+
Please place new portions of `api_changes.rst` in the
7+
`next_api_changes` directory.
48

5-
For changes which require an entry in `api_changes.rst` please create
6-
a file in this folder with the name :file:`YYYY-MM-DD-[initials].rst`
7-
(ex :file:`2014-07-31-TAC.rst`) with contents following the form: ::
9+
When adding an entry please look at the currently existing files to
10+
see if you can extend any of them. If you create a file, name it
11+
:file:`what_api_changes.rst` (ex :file:`deprecated_rcparams.rst`) with
12+
contents following the form: ::
813

914
Brief description of change
1015
---------------------------

doc/users/next_whats_new/README.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
:orphan:
2+
13
What's new in unreleased Matplotlib?
24
====================================
35

0 commit comments

Comments
 (0)