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

Patch search index #4290

Closed

Conversation

aaruni96
Copy link
Member

@aaruni96 aaruni96 commented Nov 7, 2024

This removes anything in search index that is not also present in doc.main. That is, the search function will not return "hidden" pages, which are not available via normal navigation. This was easier than trying to make Documenter make a nice search index to begin with which needed more digging into ( JuliaDocs/Documenter.jl#2517 )

Address @lgoettgens comment from #3816 :

Can you maybe just disable all results from files that are not contained in the doc.main file, i.e. the list of files reachable via the menu?

This removes anything in search index that is not also present in doc.main.
That is, the search function will not return "hidden" pages, which are not
available via normal navigation.
@aaruni96 aaruni96 added the documentation Improvements or additions to documentation label Nov 7, 2024
@fingolfin
Copy link
Member

Unfortunately it is a bit annoying to test this, as while we generate previews of documentation changes, this only works for branches contained in oscar-system/Oscar.jl directly. Ideally, could you perhaps move your branch there and open a new PR to replace this one, so that we can do so?

@aaruni96 aaruni96 mentioned this pull request Nov 7, 2024
@aaruni96
Copy link
Member Author

aaruni96 commented Nov 7, 2024

Closing in favor of #4292

@aaruni96 aaruni96 closed this Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants