Skip to content
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

Closed
wants to merge 2 commits into from

Conversation

timmoon10
Copy link
Collaborator

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

  • Documentation change (change only to the documentation, either a fix or a new content)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Infra/Build change
  • Code refractor

Changes

  • Update dependency versions in GitHub action for docs
  • Remove deprecated options from RTD theme
  • Fully commit to pathlib.Path in anticipation of Sphinx 9 deprecating str paths
  • Miscellaneous reorganization and cleanup

Checklist:

  • I have read and followed the contributing guidelines
  • The functionality is complete
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Signed-off-by: Tim Moon <tmoon@nvidia.com>
@timmoon10 timmoon10 added bug Something isn't working documentation Improvements or additions to documentation labels Oct 18, 2024
@timmoon10 timmoon10 requested review from ptrendx and ksivaman October 18, 2024 00:42
# -- 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()]
Copy link
Collaborator Author

@timmoon10 timmoon10 Oct 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -106,7 +98,7 @@
"css/nvidia_footer.css",
]

html_theme_options = {"display_version": True, "collapse_navigation": False, "logo_only": False}
Copy link
Collaborator Author

@timmoon10 timmoon10 Oct 18, 2024

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:

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)

@timmoon10
Copy link
Collaborator Author

Pipeline 19467512

@timmoon10 timmoon10 marked this pull request as draft October 19, 2024 01:00
@timmoon10 timmoon10 closed this Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant