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.14k stars 146 forks source link

Support search in docpage #415

Closed tisonkun closed 2 years ago

tisonkun commented 2 years ago

Currently, it seems the search support restricts into google search or lunr search that needs configured. Is it possible to provide in page search support like https://pulsar.apache.org/api/python/2.10.2/pulsar.html?

I'm going to migrate the page linked above to pdoc3 since pdoc3 has a better styled theme. But the searching function is significant to retain.

kernc commented 2 years ago

Lunr search should be fairly easy to configure, no? Adding a single command line switch (--config "lunr_search={}") should do it ...

tisonkun commented 2 years ago

Resolved by hosting the files with a server instead of directly open the HTML files...