sphinx icon indicating copy to clipboard operation
sphinx copied to clipboard

Make ``autodoc`` more maintainable

Open AA-Turner opened this issue 7 months ago • 3 comments

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

AA-Turner avatar Jul 25 '25 14:07 AA-Turner

https://github.com/sphinx-doc/sphinx/issues/13751#issue-3263335405

trentonstith99-crypto avatar Aug 23 '25 20:08 trentonstith99-crypto

With #13985 the class-based interface has been all-but removed.

A

AA-Turner avatar Oct 21 '25 23:10 AA-Turner

Excited about this refactor, but could you make sure there is space to extend this for custom domains? I like the idea of having distinct domain directives vs autodoc directives to make it easier to debug and make the implementation easier to follow.

LecrisUT avatar Nov 01 '25 00:11 LecrisUT