sphinx-doc / sphinx-doc/sphinx
Enum type interpreted as function name
Open
Nobody has claimed this yet.
domains:c
domains:cpp
type:bug
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
In the following example:
.. function:: enum gimple_code gimple_code (gimple g)
Return the code for statement ``G``.
There's a wrongly created a hyperlink to the function (after enum keyword):
How to Reproduce
Build the snippet.
Expected behavior
No response
Your project
Build the snippet
Screenshots
No response
OS
Linux
Python version
3.8
Sphinx version
4.3.1
Sphinx extensions
No response
Extra tools
No response
Additional context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by building the provided reStructuredText snippet with Sphinx 4.3.1 and inspect the generated links. Trace the handling of the function directive and verify that enum is not linked as a function name while the actual function name remains linked.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100