-
Notifications
You must be signed in to change notification settings - Fork 753
Modify theme to disable extranav #3309
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
Conversation
|
Kicked off a package docs build in this run: https://github.com/ansible/ansible-documentation/actions/runs/19646384096 |
|
Without the search box in the sidebar, IMO the search is harder to find. It took me some time to figure out that I have to click on the RTD widget. (And then I need yet another click to be able to enter anything.) |
|
Package docs build on the test site: https://ansible-community.github.io/package-doc-builds/
|
I guess we could drop that commit and start a forum topic? I know the search bar in the theme uses a swiftype or something like that for search. From my own experimentation the results aren't as good as RTD. We've heard in the past on the forum about how the results from the search bar kind of suck. One of the benefits of RTD is better search and I'd kind of like to promote that. RTD also lets you search across subprojects, which is brilliant. But I def don't want to take anything away that folks find useful. Or cause frustration. Maybe we can have both? |
Ah, actually the preview behaves differently from the actual docsite. I was looking at https://ansible--3306.org.readthedocs.build/projects/ansible-core/3306/, and there RTD hijacks the search bar: if you click on it, RTD's search window opens directly. Hmm, and the same happens on https://docs.ansible.com/projects/ansible-core/devel/. But on https://docs.ansible.com/projects/ansible/devel/, it behaves differently: there, the search box works, and there it uses swifttype I guess. So now I'm confused. What's the difference between https://docs.ansible.com/projects/ansible/devel/ and https://docs.ansible.com/projects/ansible-core/devel/ ? |
|
Wow, that's interesting. It's the same for Receptor docs: https://docs.ansible.com/projects/receptor/en/latest/ I wouldn't imagine it's down to the fact that the package docs build takes place on GitHub runners instead of the RTD ones... |
|
@felixfontein I think it must be that RTD is injecting search functionality that overrides the searchbar for Receptor and ansible-core docs. Perhaps we need to do something like this: https://docs.readthedocs.com/platform/latest/addons.html#integrate-with-search-as-you-type I'll take a look but will drop the commit to disable search. Maybe it's better to see if we can make the package docs search behave like Receptor and core docs. Also, for some historical context about search: |
8f6997b to
30e3f28
Compare
|
@felixfontein This should be ready for review now. I dropped the commit to disable the search box. I'm going to work on a fix for that separately. |
Backport to stable-2.18: 💚 backport PR created✅ Backport PR branch: Backported as #3320 🤖 @patchback |
(cherry picked from commit 348f664)
Backport to stable-2.19: 💚 backport PR created✅ Backport PR branch: Backported as #3321 🤖 @patchback |
(cherry picked from commit 348f664)
Backport to stable-2.20: 💚 backport PR created✅ Backport PR branch: Backported as #3322 🤖 @patchback |
(cherry picked from commit 348f664)
Backport to stable-2.17: 💚 backport PR created✅ Backport PR branch: Backported as #3323 🤖 @patchback |
(cherry picked from commit 348f664)


This change modifies the theme to disable extranav.