Commit c93517a
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 <seisman.info@gmail.com>1 parent e30b2d7 commit c93517a
File tree
5 files changed
+439
-453
lines changed- .github
- doc
5 files changed
+439
-453
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
9 | | - | |
| 8 | + | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
| 12 | + | |
| 13 | + | |
12 | 14 | | |
13 | 15 | | |
14 | | - | |
15 | | - | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
| 18 | + | |
| 19 | + | |
19 | 20 | | |
20 | | - | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
21 | 24 | | |
22 | | - | |
| 25 | + | |
23 | 26 | | |
24 | 27 | | |
25 | 28 | | |
26 | 29 | | |
27 | 30 | | |
28 | | - | |
| 31 | + | |
29 | 32 | | |
30 | 33 | | |
0 commit comments