Use sphinx built-in Napoleon with the upstream patch #428
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
lukpueh
requested changes
Feb 16, 2021
There was a problem hiding this comment.
Cool stuff, @SolidifiedRay! I have 2 minor nitpicks. Please fix an we can merge.
Signed-off-by: SolidifiedRay <yc3346@nyu.edu>
SolidifiedRay
force-pushed
the
sphinx-update
branch
from
980626f
to
e046903
Compare
|
I have updated the fix. Thanks for the review! @lukpueh |
adityasaky
approved these changes
Feb 17, 2021
|
Great work, @SolidifiedRay, good stuff with the upstream merge! |
lukpueh
approved these changes
Feb 17, 2021
Merged
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.
Fixes issue #401:
Description of the changes being introduced by the pull request:
I submitted a patch to the Sphinx community to support our custom Side Effect docstring section. This patch was merged and released in Sphinx v3.5.0, so we can now replace the temporary napoleon fork (PR #420) with the sphinx built in Napoleon extension.
See: sphinx-doc/sphinx#8658
Please verify and check that the pull request fulfills the following
requirements: