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

Add a « search in api docs » in readthedocs search bar #632

Open
tristanlatr opened this issue Jul 30, 2022 · 1 comment
Open

Add a « search in api docs » in readthedocs search bar #632

tristanlatr opened this issue Jul 30, 2022 · 1 comment

Comments

@tristanlatr
Copy link
Contributor

tristanlatr commented Jul 30, 2022

But also we should investigate the option of adding a « search in api docs » button from the readthedocs search bar.

I think that this can be done in 2 steps:

  1. Have pydoctor generate a dedicated search-results.html page that takes the search term from the URL. The important part to allow search input from the URL, not only via typing.

  2. Create a raw HTML element on any Sphinx page with a form field that will make a GET to that page.

Originally posted by @adiroiban in #608 (comment)

@tristanlatr tristanlatr changed the title > But also we should investigate the option of adding a « search in api docs » In readthedocs search bar. Add a « search in api docs » in readthedocs search bar Jul 30, 2022
@tristanlatr
Copy link
Contributor Author

Maybe we can change the place of the search help as well, create another page just for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant