Rename API files to use MDX extension #1013
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
Eric-Arellano
changed the title
Eric-Arellano
changed the title
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
API docs use Markdown components, and are about to use a lot more of them with the new API components like Qiskit#1008. It's confusing to pretend they're MD files. This PR makes things consistent, which allows us to simplify some of our scripts to only deal with MDX and IPYNB extensions. The API docs were manually changed with this Bash snippet: ```bash for file in docs/api/**/*.md; do if [ -f "$file" ]; then mv "$file" "${file%.md}.mdx" fi done ```
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.
API docs use Markdown components, and are about to use a lot more of them with the new API components like #1008. It's confusing to pretend they're MD files.
This PR makes things consistent, which allows us to simplify some of our scripts to only deal with MDX and IPYNB extensions.
The API docs were manually changed with this Bash snippet: