sphinx-doc/sphinx

C functions are not shown in sidebar

Closed

#11,424 opened on May 15, 2023

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)Python (1,985 forks)batch import
domains:chelp wantedinternals:toctree

Repository metrics

Stars
 (5,625 stars)
PR merge metrics
 (Avg merge 10d 11h) (11 merged PRs in 30d)

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

Contributor guide

Research direction
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
Domain
documentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSphinx internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60