microsoft/vasim

TODO: setup documentation generation

Offen

#5 geöffnet am 30.08.2024

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (7 Forks)auto 404
TODOdocumentationhelp wanted

Repository-Metriken

Stars
 (12 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

As we slowly add the documentation, we also should setup auto doc generation. The pipeline code is in place. This particular setup uses sphinx but there are many options we could chose from.

Contributor Guide

Research-Richtung
Richten Sie die Sphinx Dokumentationsgenerierung ein: Erstellen Sie ein 'docs' Verzeichnis, fügen Sie conf.py, index.rst hinzu und konfigurieren Sie die Bereitstellung auf GitHub Pages oder Read the Docs.
Tech Stack
python
Domain
developer experience
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.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonSphinx
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80