Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Improve autogenerated SDK documentation

Fermée
#36 2 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
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
python
Domaine
documentation

Piste de recherche

Commencez par inspecter la documentation générée à l’adresse crossplane.github.io/function-sdk-python/function.html ainsi que la sortie de documentation générée à partir de protobuf du Python SDK. Examinez comment la documentation actuelle est générée, notamment si Sphinx ou MkDocs est déjà utilisé. Le travail sera considéré comme terminé lorsque la documentation disposera d’une page d’accueil utile, d’un versionnage et d’une couverture du code généré à partir de protobuf, et que l’approche nécessitera peu de maintenance.

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

Description

documentation enhancement
What problem are you facing?

We have autogenerated SDK documentation at https://crossplane.github.io/function-sdk-python/function.html, but it's not great.

Some things that could be improved:

  • There's no versioning - the generated docs always and only reflect the main branch.
  • The landing page is empty.
  • There's no documentation for the protobuf generated code.

Documentation for the protobuf generated code seems like it would be very valuable, since there's not much else to this SDK apart from a few utilities. Unfortunately the code itself doesn't seem to have docstrings, despite the protobuf messages it's generated from having them.

How could this Function help solve your problem?
  • Figure out if there's some way to copy docstrings from the protobuf schema to the generated code.
  • Use a better docs tool (Sphinx, mkdocs, etc). Ideally something low maintenance.
Langage dominant
Python
Étoiles
12
Forks
15
Merge moyen
1 j 12 h
PR mergées (30 j)
7

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 crossplane/function-sdk-python

Toutes les issues de crossplane/function-sdk-python

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.