Parse docstrings as markdown #491
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
We have markdown in docstrings of our generated modules. This causes issues with sphinx autodoc parser. - Switch to autodoc2 and myst to properly parse markdown. - Patch invalid markdown before parsing. - Switch to "Read the Docs" theme and normalize TOC for better presentation. Closes #78
|
Preview: https://ibm.github.io/cloudant-python-sdk/docs/dev/ I'll rollback demo commit in `gh-pages after merge |
eiri
commented
May 30, 2023
eiri
commented
May 30, 2023
eiri
commented
May 30, 2023
ricellis
reviewed
May 30, 2023
Co-authored-by: Rich Ellis <ricellis@users.noreply.github.com>
ricellis
approved these changes
May 31, 2023
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.
PR summary
We have markdown in docstrings of our generated modules. This causes issues with sphinx autodoc parser.
Fixes: #78
Note: An existing issue is required before opening a PR.
PR Checklist
Please make sure that your PR fulfills the following requirements:
Angular Commit Message Guidelines.
PR Type
What is the current behavior?
What is the new behavior?
Does this PR introduce a breaking change?
Other information