microsoft / microsoft/azure-devops-python-api
How to build Sphinx documentation to list Functions/Methods with parameters and expected returns?
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 684
- Forks
- 218
- Ø Merge
- 8 T. 10 Std.
- Gemergte PRs (30 T.)
- 1
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Durchsicht der verlinkten Dokumentationsbeispiele im Sphinx-Napoleon- und NumPy-Stil und untersuche anschließend, wie dieses Repository derzeit seine Python API dokumentiert. Das Issue nennt keine Dateien, keinen Einstiegspunkt und kein konkretes Abschlusskriterium; kläre den gewünschten Umfang der Dokumentation und das akzeptierte Ergebnis mit einem Maintainer, bevor du beginnst.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 20/100