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

fix: add sphinx_rtd_theme to extensions in conf.py #473

Merged
merged 2 commits into from
May 10, 2023

Conversation

hkershaw-brown
Copy link
Member

@hkershaw-brown hkershaw-brown commented May 10, 2023

Description:

Add sphinx_rtd_theme so we use the latest version of the rtd theme.
This fixes the search function and flyout menu for readthedocs documentation
See issue #471 for discussion

Fixes issue

fixes #471

Types of changes

  • 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)
  • Documentation update

Tests

Please describe any tests you ran to verify your changes.
Built the docs, checked the search and the flyout menu (version choice bottom left) worked:
https://docs.dart.ucar.edu/en/doc-search-fix/README.html

compare to https://docs.dart.ucar.edu/en/v10.7.1/README.html

Checklist for merging

  • Updated changelog entry
  • Documentation updated
  • Update conf.py

Checklist for release

  • Merge into main
  • Create release from the main branch with appropriate tag
  • Delete feature-branch

Testing Datasets

  • Dataset needed for testing available upon request
  • Dataset download instructions included
  • No dataset needed

fixes search and flyout menu. 
See issue #471 for discussion
Copy link
Contributor

@mjs2369 mjs2369 left a comment

Choose a reason for hiding this comment

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

Approved. Fixes the search function and flyout menu.

I agree that using the sphinx_rtd_theme is the best way to do this.

@hkershaw-brown hkershaw-brown merged commit 72e5740 into main May 10, 2023
@hkershaw-brown hkershaw-brown deleted the doc-search-fix branch May 10, 2023 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug: readthedocs build failing
2 participants