sphinx-doc/sphinx

C functions are not shown in sidebar

Fermée

#11 424 ouverte le 15 mai 2023

Voir sur GitHubGuide contributeur
 (3 commentaires) (0 réaction) (0 personne assignée)Python (1 985 forks)batch import
domains:chelp wantedinternals:toctree

Métriques du dépôt

Stars
 (5 625 étoiles)
Métriques de merge PR
 (Merge moyen 10j 11h) (11 PRs mergées en 30 j)

Description

Describe the bug

.. py:function:: or .. function:: shows function names in sidebar. But .. c:function:: does not.

How to Reproduce

.. function:: works_as_expected()

.. c:function:: void no_symbol()

Environment Information

Platform:              darwin; (macOS-13.3-arm64-arm-64bit)
Python version:        3.9.7 (default, Sep  3 2021, 04:31:11) 
[Clang 12.0.5 (clang-1205.0.22.9)])
Python implementation: CPython
Sphinx version:        6.2.1
Docutils version:      0.18.1
Jinja2 version:        3.1.2
Pygments version:      2.13.0

Sphinx extensions

No response

Additional context

No response

Guide contributeur

Direction de recherche
Investigate the C domain implementation in sphinx/domains/c.py to understand how `.. c:function::` directives handle sidebar entries. Compare with the Python domain in sphinx/domains/python.py to identify missing registration logic for generating sidebar entries. Look at functions like `add target and index` or `after content` that may be responsible for adding toctree entries.
Stack technique
python
Domaine
documentation
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonSphinx internals
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60