Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write changelog in markdown using MyST #941

Merged
merged 8 commits into from
Feb 22, 2021
Merged

Write changelog in markdown using MyST #941

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d4ee476
Install myst-parser and add it to sphinx extension list
weiji14 Feb 20, 2021
40c170b
Rename doc/changes.rst to doc/changes.md and convert to markdown
weiji14 Feb 20, 2021
3871496
Use h3 html titles for sub-headings
weiji14 Feb 20, 2021
6058ae0
[skip ci] Fix typo in v0.3.0 DOI link
weiji14 Feb 21, 2021
2491d96
Let release drafter automatically produce markdown URLs to Pull Requests
weiji14 Feb 21, 2021
634164b
[skip ci] Add missing brackets back to change-template string
weiji14 Feb 21, 2021
5bd3cb6
Merge branch 'master' into myst-changelog
weiji14 Feb 22, 2021
e79592c
Reorder categories in release note
weiji14 Feb 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions .github/release-drafter.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,19 @@ categories:
label: 'deprecation'
exclude-labels:
- 'skip-changelog'
change-template: '* $TITLE (#$NUMBER)'
category-template: '### $TITLE'
Copy link
Member Author

@weiji14 weiji14 Feb 21, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need help to find a way to make the subheaders (e.g. for v0.2.1 enhancements) a proper permalink. I.e. something like https://pygmt-git-myst-changelog.gmt.vercel.app/changes.html#v0-2-1-enhancements instead of https://pygmt-git-myst-changelog.gmt.vercel.app/changes.html#id3

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems commonmark still doesn't support anchors for headers, so maybe we can do nothing here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe do it in sphinx instead? I see https://stackoverflow.com/questions/15394347/adding-a-cross-reference-to-a-subheading-or-anchor-in-another-page#comment79146992_40225340 pointing to https://www.sphinx-doc.org/en/master/usage/extensions/autosectionlabel.html#confval-autosectionlabel_prefix_document.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The autosectionlabel_prefix_document configuration variable can be used to make headings which appear multiple times but in different documents unique.

Useful for avoiding ambiguity when the same section heading appears in different documents.

I don't think it works for us.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@weiji14 As we have no solution for the custom anchors, do you think we should not use h3 headers, but just use bold headings, i.e., use **Documentation**, not ### Documentation.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would stick with h3 headers. Even without the permalink anchors, it'll still be easier for users to navigate quickly to the subsection on the sidebar:

Changelog subsections in navbar

And people could still point to the v0.3.0 highlights using https://www.pygmt.org/v0.3.0/changes.html#highlights, and so on for v0.4.0 and beyond.

change-template: '* $TITLE [#$NUMBER]($URL)'
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
template: |
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3781524.svg)](https://doi.org/10.5281/zenodo.3781524)
## Release v$NEXT_PATCH_VERSION (20YY/MM/DD)

## Highlights
[![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)
weiji14 marked this conversation as resolved.
Show resolved Hide resolved

### Highlights

*

$CHANGES

## Contributors
### Contributors

$CONTRIBUTORS
Loading