Updates for tox and sphinx

[saimn]

While trying to make a release I found a few issues with recent version of tox and sphinx ...

[saimn]

Sphinx 6.1 deprecates sphinx.util.progress_message and I'm not sure how to get rid of that one:

Exception occurred:
  File "/home/simon/.pyenv/versions/3.11.0/lib/python3.11/site-packages/sphinx/deprecation.py", line 46, in __getattr__
    warnings.warn(f"The alias '{self._modname}.{name}' is deprecated, "
sphinx.deprecation.RemovedInSphinx80Warning: The alias 'sphinx.util.progress_message' is deprecated, use 'sphinx.util.display.progress_message' instead. Check CHANGES for Sphinx API modifications.

edit: it is raised in our tests where we run sphinx with -W, I don't know if there is a way to ignore warnings there other than removing -W

[pllim]

What is the future of automodapi ? Is it time we retire it in favor of something else that the wider ecosystem uses? If so, then maybe it is ok to ignore the warning.

[pllim]

Where is progress_message even called? I cannot find it here. If it is not our problem, let's ignore.

[saimn]

What is the future of automodapi ? Is it time we retire it in favor of something else that the wider ecosystem uses? If so, then maybe it is ok to ignore the warning.

There is https://github.com/readthedocs/sphinx-autoapi but I don't know how it compares to automodapi

[saimn]

Where is progress_message even called? I cannot find it here. If it is not our problem, let's ignore.

I don't remember exactly but it's called in some Sphinx extension I think. The problem is that in our tests we are calling sphinx-build with -W and there is no way that I know to tell Sphinx to ignore some specific warning:

sphinx-automodapi/sphinx_automodapi/tests/test_cases.py

Lines 134 to 140 in 6e476f2

	argv = ['-W', '-b', 'html', src_dir, '_build/html']
	try:
	os.chdir(docs_dir)
	status = build_main(argv=argv)
	finally:
	os.chdir(start_dir)

[pllim]

I ignored that warning in setup.cfg and now there are 3 assert errors. Do you know what is happening there?

[pllim]

Might have to put that -W back?

[codecov]

Codecov Report

Merging #157 (941f641) into main (6e476f2) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #157   +/-   ##
=======================================
  Coverage   89.90%   89.90%           
=======================================
  Files          27       27           
  Lines        1139     1139           
=======================================
  Hits         1024     1024           
  Misses        115      115           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[pllim]

Now the Windows job failed...

[saimn]

The warning ignores in setup.cfg are for pytest, not sphinx.
But it works now because the warning has been fixed : sphinx-doc/sphinxcontrib-applehelp#10 ;)

[pllim]

LoL I cannot keep up. Doesn't explain the Windows failure though.

[pllim]

@saimn , does this mean we can remove the changes to setup.cfg?

[pllim]

We don't do backports here, so I am just gonna "squash and merge" when CI passes. Thanks!

[pllim]

homebrew complained about the py37-test-sphinx24 job. Something about something unavailable. I cannot care less, so I commented it out and we can move on with our lives by not buying Apple products.

[pllim]

Thanks, @saimn !