Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Jun 28, 2021
Merged

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

merged 1 commit into from
Jun 28, 2021

Conversation

domdfcoding
Copy link
Contributor

get_documenters() has been deprecated since 3.0.0b1 but the changes to its internals occurred in sphinx-doc/sphinx#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
Copy link

codecov bot commented Jun 19, 2021

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%) ⬇️

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 Chilipp linked an issue Jun 20, 2021 that may be closed by this pull request
@Chilipp
Copy link
Owner

Chilipp commented Jun 20, 2021

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

@domdfcoding domdfcoding marked this pull request as ready for review June 28, 2021 08:00
@domdfcoding
Copy link
Contributor Author

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
Copy link
Owner

Chilipp commented Jun 28, 2021

awesome! thanks a lot @domdfcoding

@Chilipp Chilipp merged commit 20fde25 into Chilipp:master Jun 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

get_documenters is deprecated in Sphinx 5
2 participants