search

mitmproxy / pdoc

API Documentation for Python Projects
https://pdoc.dev
MIT No Attribution
1.92k stars 189 forks source link

Search Bar Yields No Results #724

Closed JLZ22 closed 1 month ago

JLZ22 commented 1 month ago

Problem Description

I am documenting a project, and typing anything into the search bar always yields no results. I am currently documenting three modules and not using any custom templates. You can find my current deployment here (yes it is very very rough). I am running pdoc -o docs/ src/[A-Z]*.py --no-show-source --footer-text "FOD Detection" --no-include-undocumented in my Github Actions workflow when building.

System Information

pdoc: 14.6.0 Python: 3.12.4 Platform: macOS-14.6-arm64-arm-64bit

mhils commented 1 month ago

This needs a minimal repro (or access to the source repository).

JLZ22 commented 1 month ago

Sorry for not providing that in the initial bug report. I have narrowed down the issue to --no-include-undocumented. When I have that flag, all searches yield "No Search results for '[your query]'". However, when I do not have this flag, the search works fine.

image image image
mhils commented 1 month ago

Again, this needs a minimal repro. pdoc --no-include-undocumented pdoc works as expected, including search.

JLZ22 commented 1 month ago

Here is a repository that I made to demonstrate the issue. I hope this is a sufficient example. Apologies for the delay.

mhils commented 1 month ago

This made it easy to track down, thanks.