Skip to content

Conversation

@oraNod
Copy link
Contributor

@oraNod oraNod commented Nov 24, 2025

This change modifies the theme to disable extranav.

@oraNod oraNod added backport-2.18 Automatically create a backport for the stable-2.18 branch backport-2.19 Automatically create a backport for the stable-2.19 branch backport-2.20 Automatically create a backport for the stable-2.20 branch labels Nov 24, 2025
@oraNod
Copy link
Contributor Author

oraNod commented Nov 24, 2025

Kicked off a package docs build in this run: https://github.com/ansible/ansible-documentation/actions/runs/19646384096

@felixfontein
Copy link
Collaborator

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.)

@oraNod
Copy link
Contributor Author

oraNod commented Nov 24, 2025

Package docs build on the test site: https://ansible-community.github.io/package-doc-builds/

image image

@oraNod
Copy link
Contributor Author

oraNod commented Nov 24, 2025

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.)

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?

@oraNod oraNod requested a review from gundalow November 24, 2025 20:24
@felixfontein
Copy link
Collaborator

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.

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/ ?

@oraNod
Copy link
Contributor Author

oraNod commented Nov 24, 2025

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...

@oraNod
Copy link
Contributor Author

oraNod commented Nov 24, 2025

@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:

@oraNod oraNod force-pushed the disable-search-theme branch from 8f6997b to 30e3f28 Compare November 24, 2025 21:11
@oraNod oraNod changed the title Modify theme to disable search and extranav Modify theme to disable extranav Nov 24, 2025
@oraNod oraNod marked this pull request as ready for review November 27, 2025 08:31
@oraNod
Copy link
Contributor Author

oraNod commented Nov 27, 2025

@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.

@gundalow gundalow merged commit 348f664 into ansible:devel Nov 27, 2025
23 checks passed
@patchback
Copy link

patchback bot commented Nov 27, 2025

Backport to stable-2.18: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.18/348f6642f81356bc2343ed287724c41ee8668074/pr-3309

Backported as #3320

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Nov 27, 2025
(cherry picked from commit 348f664)
@patchback
Copy link

patchback bot commented Nov 27, 2025

Backport to stable-2.19: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.19/348f6642f81356bc2343ed287724c41ee8668074/pr-3309

Backported as #3321

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Nov 27, 2025
(cherry picked from commit 348f664)
@patchback
Copy link

patchback bot commented Nov 27, 2025

Backport to stable-2.20: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.20/348f6642f81356bc2343ed287724c41ee8668074/pr-3309

Backported as #3322

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Nov 27, 2025
(cherry picked from commit 348f664)
oraNod added a commit that referenced this pull request Nov 27, 2025
(cherry picked from commit 348f664)

Co-authored-by: Don Naro <dnaro@redhat.com>
oraNod added a commit that referenced this pull request Nov 27, 2025
(cherry picked from commit 348f664)

Co-authored-by: Don Naro <dnaro@redhat.com>
oraNod added a commit that referenced this pull request Nov 27, 2025
(cherry picked from commit 348f664)

Co-authored-by: Don Naro <dnaro@redhat.com>
@oraNod oraNod added the backport-2.17 Automatically create a backport for the stable-2.17 branch label Nov 27, 2025
@patchback
Copy link

patchback bot commented Nov 27, 2025

Backport to stable-2.17: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.17/348f6642f81356bc2343ed287724c41ee8668074/pr-3309

Backported as #3323

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Nov 27, 2025
(cherry picked from commit 348f664)
oraNod added a commit that referenced this pull request Nov 27, 2025
(cherry picked from commit 348f664)

Co-authored-by: Don Naro <dnaro@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-2.17 Automatically create a backport for the stable-2.17 branch backport-2.18 Automatically create a backport for the stable-2.18 branch backport-2.19 Automatically create a backport for the stable-2.19 branch backport-2.20 Automatically create a backport for the stable-2.20 branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants