docs: Update Sphinx and its dependencies, Cilium theme #28172
Merged
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
Function is_html5_writer_available() is deprecated, its invocation is unnecessary (the writer _is_ available in the versions of Sphinx we're using), and it has been removed in more recent versions of Sphinx. Let's get rid of it. Signed-off-by: Quentin Monnet <quentin@isovalent.com>
Now that we have rebased our theme onto the upstream version, we can use newer versions of docutils, which allows us to update Sphinx and a bunch of dependencies. We're still limited to docutils 0.18 because of sphinx-tabs, though. One immediate improvement is that we get working links for the value types in the gRPC reference. There are newer versions of Sphinx, websupport, or some second-level dependencies available (currently 7.2.6 and 1.2.6, respectively), but Netlify doesn't know about them yet and fails to build the previews. Signed-off-by: Quentin Monnet <quentin@isovalent.com>
In the past, we disabled Sphinx's output in check-build.sh. This was because of the way we handle warnings: in order to have them printed at the end of the logs, we print them to a file, we filter them, and print the outstanding ones at the end of the output. Keeping the standard output meant that warnings or errors wouldn't appear in the middle of this output, and warnings that we filtered out wouldn't appear at all, which could be confusing. With the recent Sphinx update, we are able to filter the warnings from MyST more efficiently, directly from conf.py, and to get rid of the filters. Let's take advantage of this to re-enable the output from Sphinx. While it's not necessary to build the docs, it's occasionally helpful to debug the setup when things don't go as expected. Signed-off-by: Quentin Monnet <quentin@isovalent.com>
qmonnet
added
area/documentation
qmonnet
temporarily deployed
to
docs-builder
GitHub Actions
Inactive
Signed-off-by: Quentin Monnet <quentin@isovalent.com>
qmonnet
temporarily deployed
to
docs-builder
GitHub Actions
Inactive
|
/test |
nbusseneau
approved these changes
Sep 15, 2023
|
@nbusseneau My understanding is that I need to /test anyway if I want the checks to be all green and the PR to either get the green badge or get mergeable by me, directly. Non-relevant tests for docs PR are skipped anyway. Thanks a lot for the review! |
learnitall
approved these changes
Sep 15, 2023
maintainer-s-little-helper
bot
added
the
ready-to-merge
True, I just typically set it to |
doniacld
added
backport-pending/1.13
giorio94
added
backport-pending/1.14
aanm
added
backport-done/1.14
This was referenced Oct 17, 2023
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.
I rebased our fork of the Sphinx theme here: https://github.com/cilium/sphinx_rtd_theme/tree/cilium/rebase-2023-09
Now we can use this newer version in the docs. We can also update a bunch of other dependencies that were stuck because of the docutils version formerly required by the theme.
v2 of #28171, from Cilium repo for the deployments to work.