docs
docs copied to clipboard
Sphinx tech stack update + Tab sections in table of contents
Summary
This PR brings the following major changes:
- Update the Sphinx tech stack (i.e. Sphinx, extensions, themes)
- Allow sections in an inline tab to be shown in the document table of contents (ToC)
- Update customized Sphinx extensions to use the latest Sphinx APIs
- Page redirect definitions moved to a separate file
Details
Sphinx tech stack update
The Sphinx stack has had the following updates:
- Sphinx
7.2.6->8.2.3 - Furo
2023.9.10->2024.8.6 - All Sphinx extensions to their latest versions
Sections of inline tabs in the ToC
The sphinx-inline-tabs extension was directly added to the repo and modified to:
- Parse section titles from documents included in an inline tab
- Add section titles from inline tabs to the document ToC
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, and sitemap extensions 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.
Hello @neflyte,
Thanks for your pull request! A Core Committer will review your pull request soon. For code contributions, you can learn more about the review process here.
Newest code from neflyte has been published to preview environment for Git SHA baa6ad09cb5ee0d0f24babf92c89ca6dff1c4e00
Newest code from neflyte has been published to preview environment for Git SHA 7d9238302f669547a065fb5f99ddc34b36703afa
Newest code from neflyte has been published to preview environment for Git SHA 8d6541874a889f85ec5268af71e1937a452de4d0