Use mkdocstrings for documenting Python code

Offen

#94 erstellt am 18.8.2022 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 5/5
Geschätzter Aufwand: Über eine Woche
Anfängerfreundlichkeit: 30/100

Issue-Typ: Feature
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: python
Bereich: documentation

Rechercherichtung

Review the current manually maintained Python API documentation and the proposed mkdocstrings approach first. Check mkdocstrings/mkdocstrings#450 and #466 to determine whether the blockers are resolved. Done means the docs are generated from Python code, type hints, and docstrings without API-to-documentation mismatches.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

complexity: 3 (low) priority: 3 (low) type: docs

Current Situation

Currently, our Python APIs are manually added to the docs, which can potentially result in API <-> Docs mismatch.

Proposed Actions

Use mkdocstrings within the docs to automatically generate markdown based on Python code, type hints, and docstrings.

Implementing this is currently blocked by these issues:

mkdocstrings/mkdocstrings#450
mkdocstrings/mkdocstrings#466

Vorherrschende Sprache: Python
Sterne: 357
Forks: 22
Ø Merge: 10 Std. 31 Min.
Gemergte PRs (30 T.): 2

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 reactive-python/reactpy-django

Add coverage tests Offen

complexity: 3 (low) priority: 3 (low) type: ci

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 45/100

reactive-python/reactpy-django#274 · Erstellt am 13.12.2024
Resolve `django_form` limitations Offen

complexity: 1 (high) priority: 1 (high)

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

reactive-python/reactpy-django#270 · Erstellt am 07.12.2024
Resolve `view_to_component` limitations Offen

complexity: 2 (medium) priority: 3 (low)

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

reactive-python/reactpy-django#269 · Erstellt am 07.12.2024
Resolve `view_to_iframe` limitations Offen

complexity: 2 (medium) priority: 3 (low)

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

reactive-python/reactpy-django#268 · Erstellt am 07.12.2024
`pyscript_router` component Offen

complexity: 1 (high) priority: 2 (moderate)

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

reactive-python/reactpy-django#248 · Erstellt am 23.8.2024

Alle Issues in reactive-python/reactpy-django