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