Translate README from rst to markdown #63
Merged
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
…using m2r2 * Also translate HISTORY, CONTRIBUTING, and AUTHORS to markdown * Update content type in `setup.cfg` so README + HISTORY still renders correctly on pypi * Update all relevant `include::` directives to ``mdinclude::` from m2r2 * Fix an incorrect file reference to sample response for `node_api.get_observations()` * Add separate badges for stable and latest readthedocs builds * Disabled PDF build on readthedocs, because a change in a LaTeX library seems to have broken `make pdflatex` ([example](https://readthedocs.org/projects/pyinaturalist/builds/12041309/))
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 PR translates the README from rst to markdown, in order to make it easier for others to potentially contribute to the docs. While rst has a lot more features, it is also more niche and difficult to learn, and experience with markdown is more common. This PR also maintains compatibility with Sphinx by using m2r2 to translate and include the markdown files at build time.
Other related changes:
setup.cfgso README + HISTORY still renders correctly on pypiinclude::directives tomdinclude::from m2r2node_api.get_observations()make pdflatex(example)