algolia / algolia/sphinx-docsearch

PyData Sphinx theme: DocSearch not showing on narrow screens

Open
#35 5 comments 3 reactions 0 assignees View on GitHub
help wanted
Dominant language
Python
Stars
21
Forks
1
Avg merge
2d 5h
Merged PRs (30d)
4

Description

Split off from issue #33.

The Pydata Sphinx theme includes the searchbox twice (you can specify the template with `html_theme_options.navbar_persistent`). Once for wider screens and once for narrower screens.

The DocSearch UI can only be added once per page, so it's added to the element for wider screens only. This means the search is not available on narrower screens.

Contributor guide

Open the contributing guide

Research direction

Start by reading issue #33 and tracing how the PyData Sphinx theme handles the two searchbox placements selected by html_theme_options.navbar_persistent. Verify the DocSearch integration on both wide and narrow layouts; done means the search is available on narrow screens without adding the DocSearch UI more than once per page.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.