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.
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/
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.