testcontainers / testcontainers/testcontainers-python
Docs: generate Sphinx documentation with all (public API) classes and members.
Offen
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 2.3k
- Forks
- 386
- Ø Merge
- 4 Std. 40 Min.
- Gemergte PRs (30 T.)
- 1
Beschreibung
low priority.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die Sphinx-Dokumentationskonfiguration und die Einstiegspunkte der öffentlichen Python-API des Repositorys zu lokalisieren; im Issue werden keine Dateien oder Tests genannt. Ermittle, wie alle öffentlichen Klassen und Member einbezogen werden sollen, und überprüfe anschließend, dass die generierte Sphinx-Dokumentation sie konsistent abdeckt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 20/100