Autodoc to Autodoc2 #565
Draft
Autodoc to Autodoc2 #565
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
for more information, see https://pre-commit.ci
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #565 +/- ##
==========================================
- Coverage 89.22% 89.17% -0.06%
==========================================
Files 51 51
Lines 3592 3592
==========================================
- Hits 3205 3203 -2
- Misses 387 389 +2 ☔ View full report in Codecov by Sentry. |
|
When merging In sphinx-extensions2/sphinx-autodoc2#33 there is code for getting NumPy-style docstrings to work in autodoc2. Let's hope it will be integrated there soonish, else we should be able to adapt it locally. |
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.
What problem do you want to solve?
Replace Autodoc with Autodoc2 to make the docstrings compatible with markdown. Then discuss if the docstring style should be changed to Sphinx style or if we should wait until Autodoc2 supports a different style.
Todo