docs(qdp): improve generated Markdown rendering - #1456
Open
viiccwen wants to merge 1 commit into
Open
Conversation
Signed-off-by: viiccwen <vicwen@apache.org>
This file contains hidden or 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
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.
Related Issues
Part of #1358
Related to #1361
Changes
Why
QDP source docstrings contain reStructuredText roles and unfenced usage examples that do not render cleanly in the generated Docusaurus API reference.
This causes references such as
:meth:and:class:to appear literally and makes Python usage examples harder to distinguish from surrounding prose.How
QdpBenchmarkusage example in a fenced Python code block.QuantumDataLoaderusage example in a fenced Python code block.The changes are limited to:
qdp/qdp-python/qumat_qdp/_backend.pyqdp/qdp-python/qumat_qdp/api.pyqdp/qdp-python/qumat_qdp/loader.pyqdp/qdp-python/qumat_qdp/tensor.pyValidation
pydoc-markdown.Checklist