Skip to content

Commit c93517a

Browse files
weiji14seisman
andauthored
Write changelog in markdown using MyST (#941)
* Install myst-parser and add it to sphinx extension list MyST (Markedly Structured Text) for writing Sphinx docs in markdown! Following the installation guide of [myst-parser](https://github.com/executablebooks/myst-parser) at https://myst-parser.readthedocs.io/en/v0.13.5/using/intro.html. * Rename doc/changes.rst to doc/changes.md and convert to markdown Convert ReST syntax `doc/changes.rst` to MyST syntax `doc/changes.md`. Mostly changing the GitHub URLs from into the nicer markdown format Modified template at release-drafter.yml such that: - A h2 title (##) is used for each Release vX.Y.Z header. - Alt text for DOI button is more descriptive with version info * Use h3 html titles for sub-headings * Let release drafter automatically produce markdown URLs to Pull Requests * Reorder categories in release note Order is now "Highlights", "New Features", "Enhancements", "Deprecations", "Bug Fixes", "Documentation", and "Maintenance". Co-authored-by: Dongdong Tian <[email protected]>
1 parent e30b2d7 commit c93517a

File tree

5 files changed

+439
-453
lines changed

5 files changed

+439
-453
lines changed

.github/release-drafter.yml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,29 @@ categories:
55
label: 'feature'
66
- title: 'Enhancements'
77
label: 'enhancement'
8-
- title: 'Documentation'
9-
label: 'documentation'
8+
- title: 'Deprecations'
9+
label: 'deprecation'
1010
- title: 'Bug Fixes'
1111
label: 'bug'
12+
- title: 'Documentation'
13+
label: 'documentation'
1214
- title: 'Maintenance'
1315
label: 'maintenance'
14-
- title: 'Deprecations'
15-
label: 'deprecation'
1616
exclude-labels:
1717
- 'skip-changelog'
18-
change-template: '* $TITLE (#$NUMBER)'
18+
category-template: '### $TITLE'
19+
change-template: '* $TITLE ([#$NUMBER]($URL))'
1920
template: |
20-
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3781524.svg)](https://doi.org/10.5281/zenodo.3781524)
21+
## Release v$NEXT_PATCH_VERSION (20YY/MM/DD)
22+
23+
[![Digital Object Identifier for PyGMT v$NEXT_PATCH_VERSION](https://zenodo.org/badge/DOI/10.5281/zenodo.3781524.svg)](https://doi.org/10.5281/zenodo.3781524)
2124
22-
## Highlights
25+
### Highlights
2326
2427
*
2528
2629
$CHANGES
2730
28-
## Contributors
31+
### Contributors
2932
3033
$CONTRIBUTORS

0 commit comments

Comments
 (0)