Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Cleaner left-hand table-of-contents for API reference

Aperta
#499 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
38/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia individuando la configurazione Sphinx/AutoAPI che genera il riferimento API nella documentazione di Read the Docs. Verifica se le sue opzioni possono produrre il nome richiesto per il pacchetto di primo livello e etichette più brevi per i sottomoduli. Il lavoro è completato quando la navigazione sinistra renderizzata mostra “hats API reference” con voci come “catalog” e “inspection”, senza ripetere i nomi dei pacchetti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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?

Lingua principale
Jinja
Stelle
85
Fork
16
Merge medio
6h 18m
PR unite (30g)
1

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di lincc-frameworks/python-project-template

Tutte le issue di lincc-frameworks/python-project-template

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.