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.

Sign up for GitHub

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

Jump to bottom

search functionality? #56

Closed
cs01 opened this issue Apr 30, 2019 · 4 comments
Closed

search functionality? #56

cs01 opened this issue Apr 30, 2019 · 4 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@cs01
Copy link
Contributor

cs01 commented Apr 30, 2019 •
edited by kernc

Really loving pdoc, it has everything I would expected in a doc generation tool except for Search.

An example of a tool that does it really well is mkdocs with the mkdocs-material theme. Example docs: https://www.starlette.io/.

Any chance of something like this coming to pdoc?
@kernc kernc added enhancement New feature or request help wanted Extra attention is needed labels Apr 30, 2019
@kernc
Copy link
Member

kernc commented Apr 30, 2019 •
edited

I guess there is if somebody implements it. 😃

Is Google Custom Search or a straighforward Google search with user-specified site: / inurl: operators appended to the query an option?

@cs01 cs01 closed this as completed May 10, 2019
@kernc kernc reopened this May 10, 2019
@kernc kernc closed this as completed in 8535421 Apr 16, 2020
@jerbaroo
Copy link

jerbaroo commented May 23, 2020 •
edited

This could be a really nice feature and would be something I'm interested in implementing once I have finished my thesis this summer.

A basic method of implementation is to place all the parsed documentation into a single file with links to the places in other files. Then some javascript can search this on the frontend.

@jerbaroo
Copy link

Can we re-open this issue? Seems like a really nice feature.

@kernc
Copy link
Member

kernc commented May 23, 2020

Some of it was added in 8535421, thus closed. What you propose is tracked as #184. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request help wanted Extra attention is needed
Milestone
No milestone
Development

No branches or pull requests
3 participants
@kernc @cs01 @jerbaroo