sphinx-doc / sphinx-doc/sphinx
Make ``autodoc`` more maintainable
Open
Nobody has claimed this yet.
extensions:autodoc
internals:refactoring
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
I find autodoc hard to reason about currently; the core implementation is a 3,200 line file with unhelpful uses of mixin classes, etc. This is a tracking issue for improvements.
A
- #13744
- #13752
- #13753
- #13754
- #13755
- #13756
- #13757
- #13758
- #13759
- #13773
- #13782
- #13783
- #13796
- #13797
- #13798
- #13799
- #13801
- #13802
- #13803
- #13744
- #13804
- #13820
- #13931
- #13936
- #13941
- #13948
- #13949
- #13955
- #13958
- #13959
- #13960
- #13961
- #13962
- #13963
- #13967
- #13968
- #13970
- #13971
- #13972
- #13973
- #13974
- #13975
- #13977
- #13978
- #13982
- #13984
- #13985
- #14008
- #14009
- #14014
- #14015
- #14016
- #14017
- #14018
- #14020
- #14021
- #14027
- #14031
- #14032
- #14033
- #14034
- #14035
- #14036
- #14037
- #14039
- #14084
- #14087
- #14090
- #14091
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 reading sphinx/ext/autodoc/init.py and the linked issues listed in this tracker to identify a specific maintainability task. This issue does not define a standalone completion condition; completion would need to follow the scope and acceptance criteria of one of those linked issues.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100