Use mkdocstrings for documenting Python code

Aperta
#94 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
Python
Stelle
357
Fork
22
Merge medio
10h 31m
PR unite (30g)
2

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di reactive-python/reactpy-django

Tutte le issue di reactive-python/reactpy-django

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.