Add gp-libs: Test docs via doctest, table of contents for sphinx.ext.autodoc, change issues module
#410
Conversation
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
Codecov Report
@@ Coverage Diff @@
## master #410 +/- ##
==========================================
+ Coverage 85.72% 86.22% +0.49%
==========================================
Files 21 21
Lines 1807 1807
Branches 276 276
==========================================
+ Hits 1549 1558 +9
+ Misses 177 170 -7
+ Partials 81 79 -2
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
tony
force-pushed
the
gp-libs
branch
6 times, most recently
from
ad23154 to
fb62538
Compare
tony
changed the title
gp-libsgp-libs: Test docs via doctest, table of contents for sphinx.ext.autodoc, cange issues
tony
force-pushed
the
gp-libs
branch
3 times, most recently
from
75a80ef to
832171d
Compare
tony
added a commit
that referenced
this pull request
Sep 10, 2022
Credit goes to #410's package for docutils-based doctests
tony
force-pushed
the
gp-libs
branch
7 times, most recently
from
d169477 to
3a5d317
Compare
This makes locking much easier
Handles: - doctests in markdown - linkifying issues in changelog - rendering table of contents for sphinx.ext.autodoc directives And we can remove sphinx-autoapi
Remove sphinx-autoapi, which has broken imports. The only purpose this module had was showing table of contents. The tradeoff was a lot of difficult to track, subtle bugs. Also move to linkify_issues. A much simpler and more concise issue linker.
This makes it easier to QA doctest files via make watch_test
tony
force-pushed
the
gp-libs
branch
3 times, most recently
from
5757704 to
e9ba3e9
Compare
tony
changed the title
gp-libs: Test docs via doctest, table of contents for sphinx.ext.autodoc, cange issuesgp-libs: Test docs via doctest, table of contents for sphinx.ext.autodoc, change issues module
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.
Changes
Add gp-libs (github, site, PyPI)
Render changelog in linkify_issues
Fix Table of contents rendering with sphinx autodoc with sphinx_toctree_autodoc_fix