[MRG] Replace most RST with Markdown #973
Open
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.
This replaces the reStructuredText (RST) versions of the README and most of the hand-written RST content on the code website ( https://jonescompneurolab.github.io/hnn-core/stable/index.html ) with similar versions using MyST Markdown ( https://www.sphinx-doc.org/en/master/usage/markdown.html#markdown ). For the reasons why this is a good idea, see the point of discussion in #969. Note that the only truly new text I have added is a small part in
contributing.md
which explains our use of Sphinx/etc. Roles, including versions for both RST and MD: https://github.com/asoplata/hnn-core/blob/mardownify-code-website/doc/contributing.md#writing-the-documentation . I think this will make it easier for people to contribute to the documentation, particularly for new users who likely will never know RST.