-
Notifications
You must be signed in to change notification settings - Fork 337
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update dependencies for building documentation #1267
Conversation
Signed-off-by: Tim Moon <tmoon@nvidia.com>
for more information, see https://pre-commit.ci
# -- Options for HTML output ------------------------------------------------- | ||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output | ||
|
||
html_theme = "sphinx_rtd_theme" | ||
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This function was deprecated in the RTD theme 3.0.0 release: https://github.com/readthedocs/sphinx_rtd_theme/blob/7b894f5e7a5053dd35de406bc779020c229f20a9/sphinx_rtd_theme/__init__.py#L22-L26
@@ -106,7 +98,7 @@ | |||
"css/nvidia_footer.css", | |||
] | |||
|
|||
html_theme_options = {"display_version": True, "collapse_navigation": False, "logo_only": False} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
display_version
was deprecated in the RTD theme 3.0.0 release: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-display_version
Note that the theme no longer includes the version in the sidebar, just a pulldown menu if multiple versions are available via RTD Addons. I haven't yet thought of a good way to reproduce our hacky version pulldown menu:
TransformerEngine/docs/conf.py
Line 59 in 7681c12
Version select: <select onChange="window.location.href = this.value" onFocus="this.selectedIndex = {0}"> |
It seems we're not the only one affected by this change: readthedocs/sphinx_rtd_theme#1601 (comment)
Pipeline 19467512 |
Description
This PR updates the Sphinx-related dependencies for building docs to handle Python 3.12. I've also taken the opportunity to do miscellaneous cleanup.
Type of change
Changes
pathlib.Path
in anticipation of Sphinx 9 deprecatingstr
pathsChecklist: