JuliaDocs/Documenter.jl

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

Open

#1 986 ouverte le 2 déc. 2022

Voir sur GitHub
 (4 commentaires) (0 réactions) (0 assignés)Julia (513 forks)batch import
Format: HTMLType: Enhancementhelp wanted

Métriques du dépôt

Stars
 (910 stars)
Métriques de merge PR
 (Merge moyen 16j 9h) (3 PRs mergées en 30 j)

Description

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)

Guide contributeur

Direction de recherche
Examinez comment l'index de recherche affiche les noms de sections et reproduisez cette logique dans le code de generation de l'index manuel.
Stack technique
julia
Domaine
developer experiencetooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Julia
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60