pybind / pybind/python_example
Building the docs
Ouverte
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 530
- Forks
- 150
- Merge moyen
- 8 j 2 h
- PR mergées (30 j)
- 1
Description
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.
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 exécuter la compilation Sphinx documentée avec make html et inspectez le HTML généré ainsi que la configuration Sphinx. Déterminez pourquoi les docstrings des fonctions Python ne sont pas incluses ; le travail est terminé lorsque la documentation générée affiche ces docstrings.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 35/100