pwr-Solaar/Solaar

Docs: Build developer docs from code

Open

#2.503 geöffnet am 27. Mai 2024

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (383 Forks)batch import
enhancementhelp wanted

Repository-Metriken

Stars
 (4.528 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 1T 15h) (5 gemergte PRs in 30 T)

Beschreibung

Some code pieces already contain docstrings, which should be automatically compiled to documentation and published with GitHub pages on a page Developer documentation.

The numpydoc format is the preferred style.

Contributor Guide

Research-Richtung
Richten Sie die automatische Dokumentationsgenerierung aus Docstrings im numpydoc Format ein und veröffentlichen Sie sie auf GitHub Pages.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75