microsoft / microsoft/azure-devops-python-api
How to build Sphinx documentation to list Functions/Methods with parameters and expected returns?
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 684
- Forks
- 218
- Merge moyen
- 8 j 10 h
- PR mergées (30 j)
- 1
Description
Is there a way to use Sphinx to build documentation that would list the Function/Methods, their parameters, and expected returns? Using pydoc doesn't seem to format the docstrings properly.
Also, if it were made using something like this:
- https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html
- https://www.sphinx-doc.org/en/master/usage/extensions/example_numpy.html
it might be easier to decipher.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par examiner les exemples de documentation liés au format Sphinx Napoleon et au style NumPy, puis inspectez la manière dont ce dépôt documente actuellement son API Python. L’issue ne précise ni fichiers, ni point d’entrée, ni critère concret d’achèvement ; clarifiez avec un maintainer la portée souhaitée de la documentation et le résultat accepté avant de commencer.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 20/100