pybind / pybind/python_example
Building the docs
Offen
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 530
- Forks
- 150
- Ø Merge
- 8 T. 2 Std.
- Gemergte PRs (30 T.)
- 1
Beschreibung
Hi,
I can build the docs with Sphinx using make html but when I open the html files I can't see any of the function docstrings. I'm new to Sphinx so I might be missing something.
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
Führe zunächst den dokumentierten Sphinx-Build mit make html aus und prüfe das generierte HTML zusammen mit der Sphinx-Konfiguration. Ermittle, warum die Docstrings der Python-Funktionen nicht enthalten sind; als abgeschlossen gilt die Aufgabe, wenn die generierte Dokumentation diese Docstrings anzeigt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100