Add handling of parameter references in Sphinx documentation #5707
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
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Utilize sphinx_paramlinks plugin which adds: * link target for every parameter * new :paramref: directive Add hook that automatically injects :paramref: before every single-backticked parameter reference. The references are validated against function signature. If the signature is unavaliable than the whole step is skipped. TODO: some debug prints to be removed Signed-off-by: Krzysztof Lecki <[email protected]>
klecki
force-pushed
the
handle-paramrefs
branch
from
1bcf303 to
c98b150
Compare
Signed-off-by: Krzysztof Lecki <[email protected]>
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
mzient
reviewed
Nov 13, 2024
mzient
reviewed
Nov 13, 2024
mzient
reviewed
Nov 13, 2024
Signed-off-by: Krzysztof Lecki <[email protected]>
|
CI MESSAGE: [20356745]: BUILD STARTED |
|
CI MESSAGE: [20356745]: BUILD FAILED |
szkarpinski
approved these changes
Nov 14, 2024
mzient
approved these changes
Nov 15, 2024
|
CI MESSAGE: [20434066]: BUILD STARTED |
|
CI MESSAGE: [20434066]: BUILD PASSED |
klecki
commented
Nov 18, 2024
|
!build |
|
CI MESSAGE: [20518115]: BUILD STARTED |
|
CI MESSAGE: [20518115]: BUILD PASSED |
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.
Category: Other
Description:
Utilize sphinx_paramlinks plugin which adds:
Add hook that automatically injects :paramref: before every single-backticked parameter reference.
The references are validated against function signature. If the signature is unavaliable than the whole step is skipped.
Fix the numpydoc generation - no single ticks are required in the parameter documentation sections.
TODO:
Example
random_bbox_crop documentation source:
dali/operators/image/crop/bbox_crop.cc:175
Result:
(The link works)
Or:
Additional information:
Affected modules and functionalities:
Docs, sphinx
Key points relevant for the review:
Tests:
Just take a look at the docs
Checklist
Documentation
DALI team only
Requirements
REQ IDs: N/A
JIRA TASK: N/A