Add a release/dev.txt file and include it from release/index.rst in development versions. Add a "Changes Since Release" section with a toctree that globs adjacent "dev/*" documents. Add a sample topic document explaining how topic-specific release note documents work. This approach will allow developers to write release notes for their changes as they are made. The release manager may then consolidate and organize the notes for a specific release version.
8 lines
274 B
ReStructuredText
8 lines
274 B
ReStructuredText
0-sample-topic
|
|
--------------
|
|
|
|
* This is a sample release note for the change in a topic.
|
|
Developers should add similar notes for each topic branch
|
|
making a noteworthy change. Each document should be named
|
|
and titled to match the topic name to avoid merge conflicts.
|