lincc-frameworks / lincc-frameworks/python-project-template

RTD template: switch to sphinx_book_theme HTML theme

Offen
#519 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement
Vorherrschende Sprache
Jinja
Sterne
85
Forks
16
Ø Merge
6 Std. 18 Min.
Gemergte PRs (30 T.)
1

Beschreibung

`sphinx_book_theme` is used by hats/hats-import/lsdb/nested-pandas and it is really nice, let's use it for everything! It would probably help with #518 and #500

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die Read the Docs-Konfiguration im Template zu lokalisieren, und prüfe die Issues #518 und #500 auf verwandte Anforderungen. Prüfe, wie das aktuelle HTML-Theme ausgewählt wird, und aktualisiere das Template so, dass generierte Projekte konsistent sphinx_book_theme verwenden; abgeschlossen ist die Aufgabe, wenn die Dokumentation mit dem neuen Theme erstellt wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.