search

pdoc3 / pdoc

:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
https://pdoc3.github.io/pdoc/
GNU Affero General Public License v3.0
1.13k stars 145 forks source link

search field wont appear in generated html file #412

Closed bananisacte closed 1 year ago

bananisacte commented 1 year ago

Expected Behavior

when i generate a HTML file of my .py file in code with all the comments, i want to see "search" field on the left side above all the functions, i saw in the commits that the search was implanted

Actual Behavior

generating the file using command will not show me the search field

Steps to Reproduce

  1. run the following command pdoc --html .\main.py --output-dir docs --force
  2. open the main.html file from doc folder in webview from pycharm
  3. under "INDEX" no search bar

Additional info

kernc commented 1 year ago

Implemented, but not enabled by default. You have to tweak relevant parts of config.mako and use --template-dir switch, or use switches like --config "lunr_search={}" or --config "google_search_query='...'", with ... replaced by your desired google query filter (see config example).