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 does not find some inline code #10810

Open
n01r opened this issue Sep 8, 2022 · 0 comments
Open

Search does not find some inline code #10810

n01r opened this issue Sep 8, 2022 · 0 comments

Comments

@n01r
Copy link

n01r commented Sep 8, 2022

Describe the bug

When searching the RTD of the WarpX project, sometimes no results are found even though there are matching parts of the documentation but the string is inside a code-block/region.

How to Reproduce

For example, the search for BeamRelevant yields no results:
https://warpx.readthedocs.io/en/latest/search.html?q=BeamRelevant&check_keywords=yes&area=default
However, there is a matching string here
https://warpx.readthedocs.io/en/latest/usage/parameters.html
image

This search, on the other hand, yields a result and the match is inside inline code
https://warpx.readthedocs.io/en/latest/search.html?q=ParticleHistogram&check_keywords=yes&area=default#

  1. Downloading the code
  2. Building the documentation

Expected behavior

I would expect to be able to find all matching documentation, even when inside a code block.

Your project

https://github.com/ECP-WarpX/WarpX

Screenshots

No response

OS

Mac & Linux

Python version

3.7

Sphinx version

5.1.1

Sphinx extensions

breathe-4.34.0, docutils-0.16, sphinxcontrib-applehelp-1.0.2, sphinxcontrib-devhelp-1.0.2, sphinxcontrib-htmlhelp-2.0.0, sphinxcontrib-jsmath-1.0.1, sphinxcontrib-qthelp-1.0.3

Extra tools

No response

Additional context

No response

@n01r n01r added the type:bug label Sep 8, 2022
@AA-Turner AA-Turner added this to the some future version milestone Sep 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants