DOC: add the API notes from Matplotlib discussion #21
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds API design notes from a Matplotlib discussion to the documentation while incorporating the MyST parser dependency.
- Adds myst-parser to documentation requirements and configuration files
- Introduces a new Api_Notes.md file with detailed API notes
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| requirements-doc.txt | Added the myst-parser dependency |
| docs/source/conf.py | Included myst_parser in the Sphinx extensions list |
| docs/source/Api_Notes.md | Added a new document outlining API design notes |
Files not reviewed (1)
- docs/source/index.rst: Language not supported
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
Moved notes from matplotlib/matplotlib#29836 to here.
Didn't feel like converting from MD to rst so just added myst as a doc dependency