search

Chilipp / autodocsumm

Extending your autodoc API docs with a summary
Apache License 2.0
48 stars 14 forks source link

Allow Sphinx v5 #79

Closed EpicWink closed 2 years ago

EpicWink commented 2 years ago

Allow and explicitly test against Sphinx v5

Fix #78

codecov[bot] commented 2 years ago

Codecov Report

Merging #79 (71bf369) into master (2839945) will increase coverage by 0.64%. The diff coverage is n/a.

@@            Coverage Diff             @@
##           master      #79      +/-   ##
==========================================
+ Coverage   84.19%   84.83%   +0.64%     
==========================================
  Files           1        1              
  Lines         310      310              
==========================================
+ Hits          261      263       +2     
+ Misses         49       47       -2
Impacted Files Coverage Δ
autodocsumm/__init__.py 84.83% <0.00%> (+0.64%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 2839945...71bf369. Read the comment docs.

Chilipp commented 2 years ago

Ah sorry, forgot about this issue @EpicWink thanks for contributing!

jenshnielsen commented 2 years ago

@Chilipp Thanks for an awesome package IMHO it makes navigating the autogenerated docs so much better. Any chance we can see a new release with sphinx 5 support soon. I have been working on a patch for sphinx.ext.autosummary in https://github.com/sphinx-doc/sphinx/pull/10691 which fixes documentation of inherited attributes, This resolves the one problem that I have been having with autodocsumm but the branch targets sphinx 5.x

Chilipp commented 2 years ago

hey @jenshnielsen! yes, sure. sorry