jbms / sphinx-immaterial

Adaptation of the popular mkdocs-material material design theme to the sphinx documentation system
https://jbms.github.io/sphinx-immaterial/
Other
177 stars 28 forks source link

Search missing most content #235

Closed vsoch closed 1 year ago

vsoch commented 1 year ago

Hiya! I'm using your theme at https://flux-framework.org/flux-operator (love it!) and I've noticed that the search isn't showing most of the content (e.g., browse the site, find a term, search for it, no results?)

This might not be related to your theme but using markdown for the source files - as an example for another related project https://flux-framework.readthedocs.io/en/latest/ we use .rst and the search seems well populated.

Have you seen this bug before and do you know if there is a fix or workaround for it? Or do you know the right place I might ask? Thank you!

jbms commented 1 year ago

It sounds like this issue:

https://github.com/sphinx-doc/sphinx/pull/11192

I don't think there is currently a released version with this fix so you will need to use an older version of Sphinx.

vsoch commented 1 year ago

Gotcha - I’ll test this out and post an update (and close after that). Thanks for the quick response and your expertise! 🙏

vsoch commented 1 year ago

Worked like a charm! For anyone that stumbles on this issue, the fix was just to install from the sphinx master (temporary) until the change is released. E.g., in my docs build for GitHub pages:

# Install sphinx from master for this bug:
# https://github.com/sphinx-doc/sphinx/pull/11192
git clone --depth 1 https://github.com/sphinx-doc/sphinx /tmp/sphinx
cd /tmp/sphinx
pip install .
cd -

And then install your other deps (sphinx will be found) and build the docs, push to gh-pages, working again!

image

Thanks so much @jbms - I would never have stumbled on this fix.