lincc-frameworks / lincc-frameworks/python-project-template
Cleaner left-hand table-of-contents for API reference
Personne n'a encore pris cette issue.
- Langage dominant
- Jinja
- Étoiles
- 85
- Forks
- 16
- Merge moyen
- 6 h 18 min
- PR mergées (30 j)
- 1
Description
Looking at the HATS RTD, the menu options in the left-hand-side for the API reference have a lot of unnecessary duplication:
API reference
└── hats
├── hats.catalog
├── hats.inspection
└── ...
I would really love if we could have it be simpler:
hats API reference
├── catalog
├── inspection
└── ...
this includes the package name in the top-level, and omits the package name from the submodule names.
I don't even know if sphinx/autoapi supports this, but I can dream, right?
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par localiser la configuration Sphinx/AutoAPI qui génère la référence d’API dans la documentation de Read the Docs. Vérifiez si ses options permettent de produire le nom demandé pour le paquetage de niveau supérieur et des libellés plus courts pour les sous-modules. C’est terminé lorsque la navigation rendue à gauche affiche « hats API reference » avec des entrées telles que « catalog » et « inspection », sans répéter les noms des paquetages.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Fonctionnalité
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 38/100