Chilipp / autodocsumm

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

Use app.registry.documenters rather than get_documenters(app) #57

Closed domdfcoding closed 3 years ago

domdfcoding commented 3 years ago

get_documenters() has been deprecated since 3.0.0b1 but the changes to its internals occurred in https://github.com/sphinx-doc/sphinx/pull/5370 , which made it into 2.0.0.

As the function just returns app.registry.documenters, and autodocsumm requires Sphinx>=2.2, there should be no problem switching away from the deprecated function.

codecov[bot] commented 3 years ago

Codecov Report

Merging #57 (17769dc) into master (3510543) will decrease coverage by 0.04%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #57      +/-   ##
==========================================
- Coverage   86.82%   86.77%   -0.05%     
==========================================
  Files           1        1              
  Lines         296      295       -1     
==========================================
- Hits          257      256       -1     
  Misses         39       39              
Impacted Files Coverage Δ
autodocsumm/__init__.py 86.77% <100.00%> (-0.05%) :arrow_down:

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 3510543...17769dc. Read the comment docs.

Chilipp commented 3 years ago

hey @domdfcoding! thanks a lot for your input =) looks good to me. let me know when this is ready to get merged

domdfcoding commented 3 years ago

I've tested this with a few of my projects just to make sure everything worked OK, and I think this is now ready for review.

Chilipp commented 3 years ago

awesome! thanks a lot @domdfcoding