Skip to content

Read the docs theme update#1117

Open
hkershaw-brown wants to merge 3 commits into
mainfrom
rtd-theme-update
Open

Read the docs theme update#1117
hkershaw-brown wants to merge 3 commits into
mainfrom
rtd-theme-update

Conversation

@hkershaw-brown
Copy link
Copy Markdown
Member

@hkershaw-brown hkershaw-brown commented May 22, 2026

Description:

This pull request updates the documentation them to sphinx-rtd-theme==3.1.0
The reason for updating is to use the readthedocs search.

Note for reviewers, the readthedocs search is only on the web (docs.dart.ucar.edu/version). Local builds will still have the same search as we have now.

The small downside I have found is that readthedocs doesn't instantly update the search index it builds, but I don't think this is a dealbreaker.

The setting
html_use_index = False
is to stop building an index page (D for data assimilation, O for awesome, etc.). We'd been using this to force results to show up in the previous theme's search. We may actually want an index page at some point in the future.

Fixes issue

fixes #1106

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 - the sphinx theme

Documentation changes needed?

  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.

Tests

Please describe any tests you ran to verify your changes.

Local builds, and
https://docs.dart.ucar.edu/en/rtd-theme-update/index.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

turning off this html output. Maybe we want an index?
Currently the .. index entries are used to 'hack' the js search.
This does not work with the read-the-docs server side search
@hkershaw-brown hkershaw-brown requested a review from mjs2369 May 22, 2026 17:15
@hkershaw-brown
Copy link
Copy Markdown
Member Author

Also if you are building the docs locally note new requirements.txt for the new theme.

python -m venv new-docs-env
source new-docs-env/bin/activate
pip install -r $DART/guide/requirements.txt

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.

Use readthedocs server side search to get better search features?

1 participant