Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the version of Sphinx in our CI machines #7983

Closed
bneradt opened this issue Jun 23, 2021 · 4 comments
Closed

Update the version of Sphinx in our CI machines #7983

bneradt opened this issue Jun 23, 2021 · 4 comments
Assignees

Comments

@bneradt
Copy link
Contributor

bneradt commented Jun 23, 2021

Currently, the CI builds our ATS Sphinx docs with Sphinx version 2.0.1. This can be seen from this job:
https://ci.trafficserver.apache.org/view/10.x%20master/job/docs-master/

Making html in uml
...
Running Sphinx v2.0.1
...

Currently the latest version is 4.0.2. We are currently pinned to the 3.x releases however due to the issue described in #7941.

The fix for that is slated for the next Sphinx 4.0.3 release (see sphinx-doc/sphinx#9322).

Thus, currently, developers will build their docs with Sphinx 3.x on their local machines, and then CI will run in v2.0.1. This difference can cause unexpected Sphinx compilation issues. We should update the CI machine with a more recent Sphinx version.

Before we do this, however, we need to make sure that the docs will build for our supported 8.x, 9.x, and master branches using the later Sphinx version.

@bneradt bneradt self-assigned this Jun 23, 2021
@bneradt
Copy link
Contributor Author

bneradt commented Jun 23, 2021

Before we can update CI, we need to update our 8.1.x and 7.1.x branches for Sphinx 3.x. Currently building docs on those branches with Sphinx 3.x fails due to a small variety of issues. These PRs unblock this issue:

@bneradt
Copy link
Contributor Author

bneradt commented Jun 23, 2021

In addition to the above, I noticed 9.0.x needs a couple updates as well for Sphinx 3.x:

@bneradt
Copy link
Contributor Author

bneradt commented Jun 23, 2021

Resolving this issue (i.e., updating CI to have Sphinx 3.x installed) unblocks #7978

@bneradt
Copy link
Contributor Author

bneradt commented Mar 21, 2022

This should be fixed now with the new CI.

@bneradt bneradt closed this as completed Mar 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant