sphinx-doc/sphinx

C functions are not shown in sidebar

Fechada

#11.424 aberto em 15 de mai. de 2023

Ver no GitHubGuia do colaborador
 (3 comentários) (0 reação) (0 responsável)Python (1.985 forks)batch import
domains:chelp wantedinternals:toctree

Métricas do repositório

Stars
 (5.625 estrelas)
Métricas de merge de PR
 (Mesclagem média 10d 11h) (11 fundiu PRs em 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

Guia do colaborador

Direção de pesquisa
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.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonSphinx internals
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60