pybind / pybind/python_example
Building the docs
Aperta
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 530
- Fork
- 150
- Merge medio
- 8g 2h
- PR unite (30g)
- 1
Descrizione
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.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia eseguendo la build di Sphinx documentata con make html e ispeziona l'HTML generato insieme alla configurazione di Sphinx. Determina perché i docstring delle funzioni Python non vengono inclusi; il lavoro è completato quando la documentazione generata visualizza tali docstring.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 35/100