[trafficserver] branch master updated: Revert "Use Sphinx 4.x (second attempt) (#8757)" (#8771)

[bn...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

bneradt pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git


The following commit(s) were added to refs/heads/master by this push:
     new 4fa1c0c  Revert "Use Sphinx 4.x (second attempt) (#8757)" (#8771)
4fa1c0c is described below

commit 4fa1c0c6730b383a9f0f159fc91747352fb110a3
Author: Brian Neradt <br...@gmail.com>
AuthorDate: Wed Mar 30 10:09:08 2022 -0500

    Revert "Use Sphinx 4.x (second attempt) (#8757)" (#8771)
    
    This reverts commit 4dbf9147c639afdc2d6e21b98218240563ea91d2.
    
    In the previous attempt to use Sphinx 4.x, I tried to fix our CSS 4.x
    rendering by explicitly adding theme.css to the css_files html_context.
    That did indeed add the needed theme.css rendering to the various docs,
    but there are still some artifacts that don't render correctly (such as
    ts:cv parameters). Reverting 4.x for now since 3.x works fine and moving
    to 4.x is turning out to be a bigger project than I expected.
---
 doc/Pipfile | 7 ++++++-
 doc/conf.py | 1 -
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/doc/Pipfile b/doc/Pipfile
index d0c0d5e..d481b2a 100644
--- a/doc/Pipfile
+++ b/doc/Pipfile
@@ -23,7 +23,12 @@ verify_ssl = true
 
 [packages]
 
-sphinx = "*"
+# The latest 4.x sphinx release has issues with style rendering. The 3.x
+# releases build and render fine, however. So we currently pin to that.
+#
+# Once that issue, either with sphinx or our docs, is resolved, then we should
+# unpin sphinx by setting the following to "*".
+sphinx = "==3.*"
 
 # Sphinx 3.x builds break with the latest jinja2. This jinja2 pin can be
 # removed when we move to Sphinx 4.x.
diff --git a/doc/conf.py b/doc/conf.py
index d8a77fd..6d779d0 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -280,7 +280,6 @@ html_static_path = ['static']
 # content wrapping.
 html_context = {
     'css_files': [
-        '_static/css/theme.css',
         '_static/override.css'
     ]
 }