add a Sphinx extension#37
Open
ilia-kats wants to merge 11 commits into
Open
Conversation
This obsoletes both class arguments: The exported name is passed by autodoc and the docstring style is now determined automatically based on the Sphinx configuration.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #37 +/- ##
===========================================
- Coverage 98.07% 86.52% -11.55%
===========================================
Files 5 6 +1
Lines 312 386 +74
===========================================
+ Hits 306 334 +28
- Misses 6 52 +46
🚀 New features to boost your workflow:
|
Open
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.
As discussed in #12 and #25, this adds a Sphinx extension to do all the docstring processing that we're currently doing at import time. Docstrings are no longer modified or created at import time at all. The upside is that arguments like
docstring_styleorexported_object_nameare now obsolete, sincedocstring_stylecan be read from the Sphinx config andexported_object_nameis passed by autodoc. I kept the arguments as no-ops for backwards compatibility, but would like to remove them soon.