Use mkdocstrings for documenting Python code

Ouverte
#94 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
30/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
python
Domaine
documentation

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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
Langage dominant
Python
Étoiles
357
Forks
22
Merge moyen
10 h 31 min
PR mergées (30 j)
2

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de reactive-python/reactpy-django

Toutes les issues de reactive-python/reactpy-django

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.