sphinx-doc / sphinx-doc/sphinx
[autodoc] undefined reference for aliased type annotation in the class constructor
Open
Nobody has claimed this yet.
extensions:autodoc
type:bug
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
i'm seeing a build error because rx.PyDiGraph cannot be found
How to Reproduce
see https://github.com/danieleades/sphinx-graph/actions/runs/8684807082/job/23813057033?pr=143
Environment Information
python 3.12, sphinx 7.2.6
Sphinx extensions
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 reproducing the linked sphinx-graph workflow with Python 3.12 and Sphinx 7.2.6, then trace autodoc handling of the aliased type annotation in the class constructor. Done means the reference to rx.PyDiGraph resolves and the documentation build completes without the reported error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100