Skip to content
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

Search missing most content #235

Closed
vsoch opened this issue Mar 12, 2023 · 3 comments
Closed

Search missing most content #235

vsoch opened this issue Mar 12, 2023 · 3 comments

Comments

@vsoch
Copy link

vsoch commented Mar 12, 2023

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
Copy link
Owner

jbms commented Mar 12, 2023

It sounds like this issue:

sphinx-doc/sphinx#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
Copy link
Author

vsoch commented Mar 12, 2023

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

@vsoch
Copy link
Author

vsoch commented Mar 12, 2023

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.

@vsoch vsoch closed this as completed Mar 12, 2023
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

No branches or pull requests

2 participants