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

Enhance at-index to list section names, like the search index #1986

Open
fingolfin opened this issue Dec 2, 2022 · 4 comments
Open

Enhance at-index to list section names, like the search index #1986

fingolfin opened this issue Dec 2, 2022 · 4 comments
Labels
Format: HTML Related to the default HTML output help wanted Type: Enhancement

Comments

@fingolfin
Copy link
Contributor

At https://docs.oscar-system.org/dev/search/?q=dim I see a long list of matches for dim, but I can separate them quite well because most are in different sections and the section titles are shown.

But on the regular index at https://docs.oscar-system.org/dev/manualindex I only see the long list of dim, repeated many times -- but no hint as to where the various dim come from.

Would it be possible to enhance the index there to match the search index, i.e., to show

dim (method, Polyhedral Complexes)

and not just

dim

?

(Even better would be of course if I could also show the signature, see issue #1038)

@mortenpi
Copy link
Member

This got added at some point.

@fingolfin
Copy link
Contributor Author

If it got added, then not in any released version, as https://docs.oscar-system.org/dev/manualindex/ still has the same issue... ?

@mortenpi
Copy link
Member

The Oscar docs literally show what's being asked in the OP?
image

But with #2202, Documenter shows even more context sometimes. That said, if there are specific things missing post-#2202, please do open new issues -- we can definitely improve further.

@mortenpi
Copy link
Member

mortenpi commented Aug 23, 2023

Ohhhh, I misunderstood the issue. This is about the at-index block, not search. Yeah, okay, that hasn't changed.

@mortenpi mortenpi reopened this Aug 23, 2023
@mortenpi mortenpi changed the title Enhance index to list section names, like the search index Enhance at-index to list section names, like the search index Aug 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Format: HTML Related to the default HTML output help wanted Type: Enhancement
Projects
None yet
Development

No branches or pull requests

2 participants