docs: Move to gp-libs (our internal helpers for sphinx)
#265
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
Handles: - doctests in markdown - linkifying issues in changelog - rendering table of contents for sphinx.ext.autodoc directives And we can remove sphinx-autoapi
Codecov Report
@@ Coverage Diff @@
## master #265 +/- ##
==========================================
- Coverage 93.66% 93.65% -0.01%
==========================================
Files 11 11
Lines 1042 1041 -1
==========================================
- Hits 976 975 -1
Misses 66 66
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
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.
tony
added a commit
that referenced
this pull request
Sep 2, 2023
- Render changelog in [`linkify_issues`] - Fix Table of contents rendering with sphinx autodoc with [`sphinx_toctree_autodoc_fix`] - Deprecate `sphinx-autoapi`, per above fixing the table of contents issue This also removes the need to workaround autoapi bugs. - Test doctests in our docs via [`pytest_doctest_docutils`] (built on [`doctest_docutils`]) [`linkify_issues`]: https://gp-libs.git-pull.com/linkify_issues/ [`sphinx_toctree_autodoc_fix`]: https://gp-libs.git-pull.com/sphinx_toctree_autodoc_fix/ [`pytest_doctest_docutils`]: https://gp-libs.git-pull.com/doctest/pytest.html [`doctest_docutils`]: https://gp-libs.git-pull.com/doctest
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
Render changelog in
linkify_issuesFix Table of contents rendering with sphinx autodoc with
sphinx_toctree_autodoc_fixDeprecate
sphinx-autoapi, per above fixing the table of contents issueThis also removes the need to workaround autoapi bugs.
Test doctests in our docs via
pytest_doctest_docutils(built ondoctest_docutils)