You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by bn...@apache.org on 2022/03/25 14:54:08 UTC

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

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 4dbf914  Use Sphinx 4.x (second attempt) (#8757)
4dbf914 is described below

commit 4dbf9147c639afdc2d6e21b98218240563ea91d2
Author: Brian Neradt <br...@gmail.com>
AuthorDate: Fri Mar 25 09:53:55 2022 -0500

    Use Sphinx 4.x (second attempt) (#8757)
    
    This is a second attempt to upgrade to Sphinx 4.x. The first was #8750.
    It was noticed, however, that the new Sphinx didn't automatically
    deliver the theme.css file. This updates the conf.py file to make the
    addition of theme.css explicit.
---
 doc/Pipfile                                       | 9 +--------
 doc/conf.py                                       | 1 +
 doc/developer-guide/api/types/TSSslSession.en.rst | 2 ++
 3 files changed, 4 insertions(+), 8 deletions(-)

diff --git a/doc/Pipfile b/doc/Pipfile
index 42a9f5a..c6652a7 100644
--- a/doc/Pipfile
+++ b/doc/Pipfile
@@ -23,14 +23,7 @@ verify_ssl = true
 
 [packages]
 
-# The latest 4.x sphinx release, currently 4.0.2, fails `make html`.  For
-# details, see: https://github.com/apache/trafficserver/issues/7938
-#
-# The 3.x releases build 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 = "*"
 
 sphinx-rtd-theme = "*"
 sphinxcontrib-plantuml = "*"
diff --git a/doc/conf.py b/doc/conf.py
index 6d779d0..d8a77fd 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -280,6 +280,7 @@ html_static_path = ['static']
 # content wrapping.
 html_context = {
     'css_files': [
+        '_static/css/theme.css',
         '_static/override.css'
     ]
 }
diff --git a/doc/developer-guide/api/types/TSSslSession.en.rst b/doc/developer-guide/api/types/TSSslSession.en.rst
index 4f50ead..4b8c6f4 100644
--- a/doc/developer-guide/api/types/TSSslSession.en.rst
+++ b/doc/developer-guide/api/types/TSSslSession.en.rst
@@ -28,6 +28,8 @@ Synopsis
 
     #include <ts/apidefs.h>
 
+.. c:macro:: TS_SSL_MAX_SSL_SESSION_ID_LENGTH
+
 .. type:: TSSslSessionID
 
    .. member:: size_t len