Sphinx job failing in CI due to duplication of sympy.sets.sets

[brocksam]

All Sphinx jobs are failing with the error message /home/runner/work/sympy/sympy/doc/src/modules/sets.rst:29: WARNING: duplicate object description of sympy.sets.sets, other instance in modules/sets, use :no-index: for one of them

[moorepants]

There may also be something breaking with the furo them and the new sphinx release:

Extension error (furo):
Handler <function _html_page_context at 0x7fa40d613160> for event 'html-page-context' threw an exception (exception: This documentation is not using `furo.css` as the stylesheet. If you have set `html_style` in your conf.py file, remove it.)
make[1]: *** [Makefile:69: _html] Error 2
The docs build failed with the following errors:
/home/moorepants/src/sympy/doc/src/modules/sets.rst:29: WARNING: duplicate object description of sympy.sets.sets, other instance in modules/sets, use :no-index: for one of them

Extension error (furo):
Handler <function _html_page_context at 0x7fa40d613160> for event 'html-page-context' threw an exception (exception: This documentation is not using `furo.css` as the stylesheet. If you have set `html_style` in your conf.py file, remove it.)

[moorepants]

If I downgrade sphinx to the version 7.1.2 then the build passes (version 7.2.0 was released today).

[oscarbenjamin]

The error message says to use :no-index: but :noindex: is used:

sympy/doc/src/modules/sets.rst

Lines 29 to 30 in f060568

	.. module:: sympy.sets.sets
	:noindex:

There are a few places using :noindex: around but I don't see any :no-index:.

[oscarbenjamin]

The other error message says

If you have set `html_style` in your conf.py file, remove it.

I guess that is referring to this which is commented out:

sympy/doc/src/conf.py

Line 184 in f060568

# html_style = 'default.css'

Or possibly this which is not commented out:

sympy/doc/api/conf.py

Line 77 in f060568

html_style = 'default.css'

[oscarbenjamin]

Looks like :noindex: was renamed:

sphinx-doc/sphinx#11533

These all need to be changed as well:

$ git grep ':noindex:'
doc/src/explanation/gotchas.rst:   :noindex:
doc/src/modules/assumptions/index.rst:   :noindex:
doc/src/modules/assumptions/index.rst:   :noindex:
doc/src/modules/assumptions/index.rst:   :noindex:
doc/src/modules/functions/index.rst:   :noindex:
doc/src/modules/matrices/dense.rst:   :noindex:
doc/src/modules/polys/agca.rst:   :noindex:
doc/src/modules/polys/agca.rst:   :noindex:
doc/src/modules/polys/agca.rst:   :noindex:
doc/src/modules/rewriting.rst:   :noindex:

[oscarbenjamin]

The furo problem is something else. I tried commenting out the html_style line but that did not fix the problem.

[oscarbenjamin]

Looks like there is an issue with furo:

pradyunsg/furo#693

[moorepants]

Do you want to merge this for now #25542? Or can we merge other PRs even though the Sphinx test is failing.

[oscarbenjamin]

I've pushed the :noindex: fix to the PR as well so at least we can get that fixed now. I think it is a Sphinx bug because according to sphinx-doc/sphinx#11533 :noindex: should still work.

Actually though I have just realised that can't work because previous versions of sphinx would not work with that change...

[oscarbenjamin]

The furo bug is just an upstream bug so I guess we pinning the version is all we can do for now.

[moorepants]

I'll leave this open.

[moorepants]

Looks like sphinx just released a bug fix: https://www.sphinx-doc.org/en/master/changes.html#release-7-2-2-released-aug-17-2023 some things seem to be related to the errors we are seeing.