Convert (most of) the ".md" files to rst #7057
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
This uses a cheesy trampoline file, but it seems to work alright.
|
Fixed the Debian build in 2c6e95c. The only problem I have is that GitHub doesn't support RST when writing the release information in https://github.com/fish-shell/fish-shell/releases, but it sounds like it should be easy to convert using pandoc. |
Closed
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
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
couldcan include these in the html documentation, particularly the CHANGELOG.Currently fishshell.com includes a cheesy rendered version at https://fishshell.com/release_notes.html, 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.
TODOs: