search

Chilipp / autodocsumm

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

Warnings is deprecated #24

Closed ignaciofite closed 4 years ago

ignaciofite commented 4 years ago

Hello, I find this extension very useful thanks for the work!

While executing it the following warning comes up:

autodocsumm__init__.py:498: RemovedInSphinx40Warning: Autosummary.warnings is deprecated return self.warnings + dn + doc_nodes

The error comes from the following line: https://github.com/Chilipp/autodocsumm/blob/edba002f8e6bf1c63ac35bbffcd40147e7806685/autodocsumm/__init__.py#L498

In the following page you can check that the warnings are deprecated: https://www.sphinx-doc.org/en/master/extdev/deprecated.html

I hope this helps :).

Chilipp commented 4 years ago

Thanks @gigiogigo for reporting this! I implemented some changes and tests in #25, so this should be resolved now. If not, please reopen this issue :smiley:

ignaciofite commented 4 years ago

I just upgraded using the pip3 install --upgrade git+https://github.com/Chilipp/autodocsumm and I didn't get the warning anymore! I also tried looking for the update via pip3 list --outdated but it didn't show up, maybe the push to pypi takes more time...

Thanks a lot for fixing it so quickly! I'm glad I could help 😄 .

Chilipp commented 4 years ago

Thanks for the confirmation!

I also tried looking for the update via pip3 list --outdated but it didn't show up, maybe the push to pypi takes more time...

Yes, I did not do a new release immediately. But now, it is available on PyPi and conda-forge will come later today.