sphinx-doc/sphinx

C functions are not shown in sidebar

Chiusa

#11.424 aperta il 15 mag 2023

Vedi su GitHubGuida contributor
 (3 commenti) (0 reazioni) (0 assegnatari)Python (1985 fork)batch import
domains:chelp wantedinternals:toctree

Metriche repository

Star
 (5625 stelle)
Metriche merge PR
 (Merge medio 10g 11h) (11 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
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.
Tech stack
python
Dominio
documentation
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonSphinx internals
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60