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

Jump to bottom

Write changelog in markdown using MyST #941

Merged
merged 8 commits into from
Feb 22, 2021
Merged

Write changelog in markdown using MyST #941

merged 8 commits into from
Feb 22, 2021

Commits on Feb 20, 2021

  1. 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.
    @weiji14
    weiji14 committed Feb 20, 2021
    Configuration menu
    Copy the full SHA
    d4ee476 View commit details
    Browse the repository at this point in the history

  2. 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
    @weiji14
    weiji14 committed Feb 20, 2021
    Configuration menu
    Copy the full SHA
    40c170b View commit details
    Browse the repository at this point in the history

  3. Use h3 html titles for sub-headings

    @weiji14
    weiji14 committed Feb 20, 2021
    Configuration menu
    Copy the full SHA
    3871496 View commit details
    Browse the repository at this point in the history

Commits on Feb 21, 2021

  1. [skip ci] Fix typo in v0.3.0 DOI link

    @weiji14
    weiji14 committed Feb 21, 2021
    Configuration menu
    Copy the full SHA
    6058ae0 View commit details
    Browse the repository at this point in the history

  2. Let release drafter automatically produce markdown URLs to Pull Requests

    @weiji14
    weiji14 committed Feb 21, 2021
    Configuration menu
    Copy the full SHA
    2491d96 View commit details
    Browse the repository at this point in the history

  3. [skip ci] Add missing brackets back to change-template string 

    Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
    @weiji14 @seisman
    weiji14 and seisman committed Feb 21, 2021
    Configuration menu
    Copy the full SHA
    634164b View commit details
    Browse the repository at this point in the history

Commits on Feb 22, 2021

  1. Merge branch 'master' into myst-changelog

    @weiji14
    weiji14 committed Feb 22, 2021
    Configuration menu
    Copy the full SHA
    5bd3cb6 View commit details
    Browse the repository at this point in the history

  2. Reorder categories in release note 

    Order is now "Highlights", "New Features",
"Enhancements", "Deprecations", "Bug Fixes",
"Documentation", and "Maintenance".
    @weiji14
    weiji14 committed Feb 22, 2021
    Configuration menu
    Copy the full SHA
    e79592c View commit details
    Browse the repository at this point in the history