This is an automated email from the ASF dual-hosted git repository. cmcfarlen pushed a commit to branch 10.1.x in repository https://gitbox.apache.org/repos/asf/trafficserver.git
commit 1fee033ef195537d4ca1af8dfe2288a2d070197e Author: Brian Neradt <[email protected]> AuthorDate: Wed Mar 26 13:57:45 2025 -0500 Doc updates to prepare for Sphinx 8 (#12132) This fixes issues that Sphinx 8 highlights with our footnotes and references. This patch is in preparation of updating to Sphinx 8, which will be in a separate PR. This patch addresses: * The txn-box class-reference.en was referenced from multiple layers of the txn-box toc tree, which Sphinx 8 allerted to being a problem. Sphinx assumes a single parent for each entry in a toc. Before I assume it silently choose one over the other. It seems not needed in dev-guide to me, so I simply removed it from there. * txn_box/misc.en.rst had an unreferenced footnote which this patch removes. * cache-architecture/architecture.en.rst had two broken footnote references because there wasn't a space between the previous word and the footnote. Sphinx requires this space for the footnote to work. (cherry picked from commit dc55e46f10e783235366ed16cca17baa189e1d46) --- doc/admin-guide/plugins/txn_box/dev/dev-guide.en.rst | 8 -------- doc/admin-guide/plugins/txn_box/misc.en.rst | 8 -------- doc/developer-guide/cache-architecture/architecture.en.rst | 4 ++-- 3 files changed, 2 insertions(+), 18 deletions(-) diff --git a/doc/admin-guide/plugins/txn_box/dev/dev-guide.en.rst b/doc/admin-guide/plugins/txn_box/dev/dev-guide.en.rst index 97487af1f2..a3f801eecc 100644 --- a/doc/admin-guide/plugins/txn_box/dev/dev-guide.en.rst +++ b/doc/admin-guide/plugins/txn_box/dev/dev-guide.en.rst @@ -33,11 +33,3 @@ This section is for C++ developers working on or with |TxB|. memory-management.en dev-extractor.en dev-directive.en - -Reference -********* - -.. toctree:: - :maxdepth: 1 - - class-reference.en diff --git a/doc/admin-guide/plugins/txn_box/misc.en.rst b/doc/admin-guide/plugins/txn_box/misc.en.rst index 0cd2549b1a..bee3999b5f 100644 --- a/doc/admin-guide/plugins/txn_box/misc.en.rst +++ b/doc/admin-guide/plugins/txn_box/misc.en.rst @@ -386,11 +386,3 @@ Mutual TLS Control remapping based on whether the user agent provided a TLS certificate, whether the certificate was verified, and whether the SNI name is in a whitelist. - -.. rubric:: Footnotes - -.. [*] - - Literals are treated internally as extractors that "extract" the literal string. In practice every - feature string is an array of extractors. - diff --git a/doc/developer-guide/cache-architecture/architecture.en.rst b/doc/developer-guide/cache-architecture/architecture.en.rst index d7cc29c92f..189ef04c85 100644 --- a/doc/developer-guide/cache-architecture/architecture.en.rst +++ b/doc/developer-guide/cache-architecture/architecture.en.rst @@ -390,7 +390,7 @@ if needed to store the object. ``Doc`` layout 3.2.0 This had the problem that with only one fragment table it could not be reliable -for objects with more than one alternate[#multiple-alternates]_. Therefore, the +for objects with more than one alternate [#multiple-alternates]_. Therefore, the fragment data was moved from being a separate variable length section of the metadata to being directly incorporated in to the :cpp:class:`CacheHTTPInfoVector`, yielding a layout of the following form. @@ -720,7 +720,7 @@ The set of things which can affect cacheability are: * Plugin operations. The initial internal checks, along with their :file:`records.yaml` -overrides[#cacheability-overrides]_, are done in ``HttpTransact::is_request_cache_lookupable``. +overrides [#cacheability-overrides]_, are done in ``HttpTransact::is_request_cache_lookupable``. The checks that are done are:
