search

readthedocs / sphinx-autoapi

A new approach to API documentation in Sphinx.
https://sphinx-autoapi.readthedocs.io/
MIT License
415 stars 126 forks source link

Replace usage of deprecated sphinx.util.status_iterator #391

Closed AWhetter closed 9 months ago

AWhetter commented 1 year ago

Running the tests outputs the following warnings:

tests/test_domains.py::TestDotNetSphinxMapper::test_get_objects
  /sphinx-autoapi/.tox/py311/lib/python3.11/site-packages/autoapi/mappers/dotnet.py:145: RemovedInSphinx80Warning: The alias 'sphinx.util.status_iterator' is deprecated, use 'sphinx.util.display.status_iterator' instead. Check CHANGES for Sphinx API modifications.
    for _, data in sphinx.util.status_iterator(

tests/test_integration.py::TestJavaScript::test_integration
  /sphinx-autoapi/.tox/py311/lib/python3.11/site-packages/autoapi/mappers/base.py:210: RemovedInSphinx80Warning: The alias 'sphinx.util.status_iterator' is deprecated, use 'sphinx.util.display.status_iterator' instead. Check CHANGES for Sphinx API modifications.
    for path in sphinx.util.status_iterator(

tests/test_integration.py::TestJavaScript::test_integration
  /sphinx-autoapi/.tox/py311/lib/python3.11/site-packages/autoapi/mappers/javascript.py:53: RemovedInSphinx80Warning: The alias 'sphinx.util.status_iterator' is deprecated, use 'sphinx.util.display.status_iterator' instead. Check CHANGES for Sphinx API modifications.
    for _, data in sphinx.util.status_iterator(

tests/test_integration.py: 4 warnings
tests/python/test_pyintegration.py: 35 warnings
  /sphinx-autoapi/.tox/py311/lib/python3.11/site-packages/autoapi/mappers/base.py:312: RemovedInSphinx80Warning: The alias 'sphinx.util.status_iterator' is deprecated, use 'sphinx.util.display.status_iterator' instead. Check CHANGES for Sphinx API modifications.
    for _, obj in sphinx.util.status_iterator(

tests/test_integration.py: 3 warnings
tests/python/test_pyintegration.py: 37 warnings
  /sphinx-autoapi/.tox/py311/lib/python3.11/site-packages/autoapi/mappers/python/mapper.py:294: RemovedInSphinx80Warning: The alias 'sphinx.util.status_iterator' is deprecated, use 'sphinx.util.display.status_iterator' instead. Check CHANGES for Sphinx API modifications.
    for dir_root, path in sphinx.util.status_iterator(

tests/test_integration.py: 3 warnings
tests/python/test_pyintegration.py: 37 warnings
  /sphinx-autoapi/.tox/py311/lib/python3.11/site-packages/autoapi/mappers/base.py:294: RemovedInSphinx80Warning: The alias 'sphinx.util.status_iterator' is deprecated, use 'sphinx.util.display.status_iterator' instead. Check CHANGES for Sphinx API modifications.
    for _, data in sphinx.util.status_iterator(

We need to get these address before Sphinx v8 is released.

N-Wouda commented 12 months ago

I just noticed this pop up in my docs build after upgrading to Sphinx v7. I could pick this up sometime this week if you're not already working on this @AWhetter. Feel free to assign me.

AWhetter commented 12 months ago

Thanks for volunteering to do this! I've assigned you.