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

Document 'sidebar-search-bs.html' is now search-field.html and other PyData theme changes #329

Closed
fmaussion opened this issue Apr 29, 2021 · 3 comments · Fixed by #371
Closed
Labels
bug Something isn't working type: documentation Improvements or additions to documentation

Comments

@fmaussion
Copy link
Contributor

After the last update to 0.1.0, our builds on ReadTheDocs started to fail (full log):

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/oggm-edu/conda/latest/lib/python3.9/site-packages/sphinx/cmd/build.py", line 280, in build_main
    app.build(args.force_all, filenames)
  File "/home/docs/checkouts/readthedocs.org/user_builds/oggm-edu/conda/latest/lib/python3.9/site-packages/sphinx/application.py", line 352, in build
    self.builder.build_update()
  File "/home/docs/checkouts/readthedocs.org/user_builds/oggm-edu/conda/latest/lib/python3.9/site-packages/sphinx/builders/__init__.py", line 296, in build_update
    self.build(to_build,
  File "/home/docs/checkouts/readthedocs.org/user_builds/oggm-edu/conda/latest/lib/python3.9/site-packages/sphinx/builders/__init__.py", line 360, in build
    self.write(docnames, list(updated_docnames), method)
  File "/home/docs/checkouts/readthedocs.org/user_builds/oggm-edu/conda/latest/lib/python3.9/site-packages/sphinx/builders/__init__.py", line 534, in write
    self._write_serial(sorted(docnames))
  File "/home/docs/checkouts/readthedocs.org/user_builds/oggm-edu/conda/latest/lib/python3.9/site-packages/sphinx/builders/__init__.py", line 544, in _write_serial
    self.write_doc(docname, doctree)
  File "/home/docs/checkouts/readthedocs.org/user_builds/oggm-edu/conda/latest/lib/python3.9/site-packages/sphinx/builders/html/__init__.py", line 611, in write_doc
    self.handle_page(docname, ctx, event_arg=doctree)
  File "/home/docs/checkouts/readthedocs.org/user_builds/oggm-edu/conda/latest/lib/python3.9/site-packages/sphinx/builders/html/__init__.py", line 1061, in handle_page
    raise ThemeError(__("An error happened in rendering the page %s.\nReason: %r") %
sphinx.errors.ThemeError: An error happened in rendering the page activity_sheets/as_gallery.
Reason: TemplateNotFound('sidebar-search-bs.html')

Theme error:
An error happened in rendering the page activity_sheets/as_gallery.
Reason: TemplateNotFound('sidebar-search-bs.html')

Our environment:https://github.com/OGGM/oggm-edu/blob/master/docs/environment.yml

our conf file: https://github.com/OGGM/oggm-edu/blob/master/docs/conf.py

Pinning back to sphinx-book-theme==0.0.42 solved the issue.

Maybe related to pydata/pydata-sphinx-theme#320, I'm not sure.

@fmaussion fmaussion added the bug Something isn't working label Apr 29, 2021
@fmaussion
Copy link
Contributor Author

Note that we are using this feature here:

html_sidebars = {
    "**": ["sidebar-search-bs.html", "sbt-sidebar-nav.html", "sbt-sidebar-footer.html"]
}

Which is still documented as working at https://sphinx-book-theme.readthedocs.io/en/latest/configure.html?highlight=sidebar-search-bs.html#default-sidebar-elements?

@choldgraf
Copy link
Member

Ah good catch - the field should now be called search-field.html I believe, we need to update the documentation!

@choldgraf choldgraf changed the title TemplateNotFound('sidebar-search-bs.html') Document 'sidebar-search-bs.html' is now search-field.html and other PyData theme changes Apr 29, 2021
@choldgraf choldgraf added type: documentation Improvements or additions to documentation bug Something isn't working and removed bug Something isn't working labels Apr 29, 2021
goodboy added a commit to goodboy/tractor that referenced this issue Jun 15, 2021
@NiklasBeierl
Copy link

NiklasBeierl commented Jun 26, 2021

I am using sphinx-book-theme = "0.1.0" and set language = 'de' in my conf.py. I have not set html_sidebars.

The only thing which is not being translated on the built html site is this text on the search page: (search.html)

    Searching for multiple words only shows matches that contain
    all words.

Is that also addressed here, or should I open another ticket?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants