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.

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

Convert (most of) the ".md" files to rst #7057

wants to merge 4 commits into from


Copy link

@faho faho commented May 28, 2020


This converts (mostly automatically, via pandoc) CHANGELOG, CONTRIBUTING and README to .rst files.

The advantage is that we use rst in our documentation so there's no need to use two languages, and that we could can include these in the html documentation, particularly the CHANGELOG.

Currently includes a cheesy rendered version at, but it's not really integrated with the rest of the docs.

Note that this PR is very likely to go stale quickly - as soon as a change to the CHANGELOG is made, but I can run the conversion again.

For a view of how these render on github, check my repo

This does not convert the issue/PR templates because I'm not sure they work as rst - I think they're taken from master, so I'd have to merge it to my master branch to check, and I've not gotten around to it. They're not critical.


  • [Not really?] Changes to fish usage are reflected in user documentation/manpages.
  • [N/A] Tests have been added for regressions fixed
  • [Well, no] User-visible changes noted in -

faho added 3 commits May 28, 2020 17:47
We use sphinx with rst for our documentation, and github supports rst
here, so it seems weird to have markdown just for these.

It also allows us e.g. to include the CHANGELOG in the docs without
requiring another build dependency.
Apparently pandoc likes using `~~~` for sections, but sphinx does not.
@faho faho added enhancement docs An issue/PR that touches or should touch the docs labels May 28, 2020
@faho faho added this to the fish 3.2.0 milestone May 28, 2020
This uses a cheesy trampoline file, but it seems to work alright.
Copy link
Member Author

faho commented May 30, 2020

Merged as e6f5c78..4f6851b

@faho faho closed this May 30, 2020
Copy link

zanchey commented May 31, 2020

Fixed the Debian build in 2c6e95c.

The only problem I have is that GitHub doesn't support RST when writing the release information in, but it sounds like it should be easy to convert using pandoc.

@sorairolake sorairolake mentioned this pull request Jun 30, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 29, 2020
@faho faho deleted the all-rst branch September 23, 2021 09:40
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
docs An issue/PR that touches or should touch the docs enhancement
None yet

Successfully merging this pull request may close these issues.

None yet

2 participants