Sphinx tech stack update + Tab sections in table of contents #7972
+6,637
−4,969
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…k; Update setuptools to resolve a security vulnerability; Ensure MermaidJS dependency has a defined version
…ctree of documents with tabs
…hange; Update TOCs of all tab documents; Always add inlinetab ID as first ID in section elements
… pages that have TabContainer nodes; Disable some debug messages; Ensure sphinx_tabs environment data is properly merged for parallel builds;
…n to the log file
…HTMLTranslator type instead of Sphinx's SphinxTranslator
…e of contents elements
…ty of comments in transform.py
…oC when it's not expected
…mizations for sitemap extension
…erate individual links instead of generating during parallel document parsing
…redirect-warnings.log
cwarnermm
added
the
preview-environment
|
Newest code from neflyte has been published to preview environment for Git SHA baa6ad0 |
cwarnermm
added
preview-environment
|
Newest code from neflyte has been published to preview environment for Git SHA 7d92383 |
…e to Scoop package manager from Makefile
… if a TabContainer has already been parsed; Use a single instance of LOG_PREFIX; Set logging to DEBUG for collect_sections and sectiondata_to_toc; Add node ID utility method to TabContainer; Add logging to TabHtmlTransform; Process TabContainer nodes by walking the node tree instead of using a flat list of nodes
…y fix HTML and rST markup
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR brings the following major changes:
Details
Sphinx tech stack update
The Sphinx stack has had the following updates:
7.2.6->8.2.32023.9.10->2024.8.6Sections of inline tabs in the ToC
The
sphinx-inline-tabsextension was directly added to the repo and modified to:If a section is selected from the ToC that would appear on an inline tab that is hidden, that tab is selected before bringing the user to the desired section.
A caveat to this implementation is the loss of ToC updates when the document is scrolled. This is limited to only those documents that use tabs. All other functionality should remain the same.
Update customized Sphinx extensions
The
compass-icons,config-setting-v2,reredirects, andsitemapextensions were updated to improve data typing and log messages, and ensure the latest Sphinx APIs are used.Page redirect definitions moved to a separate file
The page redirect definitions, usually found in
conf.py, were moved to a separate file,redirects.py, to keep the main Sphinx configuration file small.Also, warnings regarding duplicate redirects are written to a separate log file,
redirect-warnings.log, to reduce noise in the main Sphinx warnings log.