Cleaner left-hand table-of-contents for API reference
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 38/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- python
- Bereich
- documentation
Rechercherichtung
Beginne damit, die Sphinx/AutoAPI-Konfiguration zu lokalisieren, die die API-Referenz in der Read the Docs-Dokumentation erzeugt. Prüfe, ob ihre Optionen den angeforderten Namen des Top-Level-Pakets und kürzere Bezeichnungen für Submodule erzeugen können. Erledigt ist die Aufgabe, wenn die gerenderte Navigation auf der linken Seite „hats API reference“ mit Einträgen wie „catalog“ und „inspection“ anzeigt, ohne wiederholte Paketnamen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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?
- Vorherrschende Sprache
- Jinja
- Sterne
- 85
- Forks
- 16
- Ø Merge
- 6 Std. 18 Min.
- Gemergte PRs (30 T.)
- 1
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus lincc-frameworks/python-project-template
-
documentation good first issue
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 45/100
lincc-frameworks/python-project-template#600 · 1 Kommentar ·
-
enhancement
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 58/100
Alle Issues in lincc-frameworks/python-project-template
Ähnliche Issues
-
Crush Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 85/100
catppuccin/catppuccin#3125 ·
-
Link Checker Report Offenautomated issue report
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 95/100
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 90/100
VoltAgent/awesome-design-md#469 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
KhronosGroup/glTF#2648 ·
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 90/100
sccn/sccn.github.io#108 ·