sphinx-doc/sphinx

C functions are not shown in sidebar

已关闭

#11,424 创建于 2023年5月15日

在 GitHub 查看贡献者指南
 (3 条评论) (0 个反应) (0 位负责人)Python (1,985 个派生)batch import
domains:chelp wantedinternals:toctree

仓库指标

星标
 (5,625 个星标)
PR 合并指标
 (平均合并 10天 11小时) (30 天内合并 11 个 PR)

描述

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

贡献者指南

研究方向
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.
技术栈
python
领域
documentation
议题类型
缺陷
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
较久未更新
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
PythonSphinx internals
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60