Consistently name the object description options by AA-Turner · Pull Request #11533 · sphinx-doc/sphinx

AA-Turner · 2023-07-28T21:06:32Z

The directive option :noindex: was renamed to :no-index:.
The directive option :noindexentry: was renamed to :no-index-entry:.
The directive option :nocontentsentry: was renamed to :no-contents-entry:.

The previous names are retained as aliases, but will be deprecated and removed in a future version of Sphinx (9.0 or later).

A

picnixz · 2023-07-29T08:17:37Z

Shouldn't there a CHANGES entry ? (at least it seems important enough for me).

oscarbenjamin · 2023-08-17T14:48:27Z

Thanks for adding the CHANGES entry because that is what enabled me to find this while investigating sympy/sympy#25541.

Above it says:

The previous names are retained as aliases

However the SymPy docs build now fails most likely because of this change:

/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

I have confirmed that changing :noindex: to :no-index: fixes this problem so I guess the alias does not work somehow.

AA-Turner · 2023-08-17T16:54:58Z

Fixed in e47846a, will be in Sphinx 7.2.2.

A

oscarbenjamin · 2023-08-17T17:14:40Z

Thanks!

AA-Turner · 2023-08-17T17:16:01Z

@oscarbenjamin Sphinx 7.2.2 has been released, please may you test with the new version?

oscarbenjamin · 2023-08-17T17:18:55Z

I'm testing here (it takes some time though):
sympy/sympy#25543

oscarbenjamin · 2023-08-17T17:38:37Z

I'm testing here

Actually that PR does not test that it is fixed because it changes to :no-index:.

I've tested Sphinx 7.2.2 in a local build and it seems fine for :noindex:. It's hard to be sure though because the Furo problem prevents a complete build (although it now shows a different error):

writing output... [  0%] citing
Extension error (furo):
Handler <function _html_page_context at 0x7f32a521bba0> for event 'html-page-context' threw an exception (exception: _CascadingStyleSheet is immutable)
make[1]: *** [Makefile:69: _html] Error 2
The docs build failed with the following errors:

Extension error (furo):
Handler <function _html_page_context at 0x7f32a521bba0> for event 'html-page-context' threw an exception (exception: _CascadingStyleSheet is immutable)
make[1]: *** [Makefile:77: printwarnings] Error 1
make: *** [Makefile:58: html] Error 2

AA-Turner · 2023-08-17T17:54:12Z

@oscarbenjamin please could you run with -T and paste the full log here? The _CascadingStyleSheet is immutable error is new, I'd like to propose a fix to Sphinx or Furo.

A

oscarbenjamin · 2023-08-17T18:02:43Z

Do you mean like

SPHINX_BUILD='sphinx-build -T' make html

oscarbenjamin · 2023-08-17T18:15:03Z

Do you mean like

SPHINX_BUILD='sphinx-build -T' make html

I tried this but it does not seem to be what you intended. The log is

$ SPHINX_BUILD='sphinx-build -T' make html
make -s _html || make -s printwarnings
Running Sphinx v7.2.2
myst v2.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'dollarmath', 'tasklist', 'linkify'}, disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=6, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=False, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
loading intersphinx inventory from https://matplotlib.org/stable/objects.inv...
loading intersphinx inventory from https://mpmath.org/doc/current/objects.inv...
loading intersphinx inventory from https://docs.scipy.org/doc/scipy/objects.inv...
loading intersphinx inventory from https://numpy.org/doc/stable/objects.inv...
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 299 source files that are out of date
updating environment: [new config] 299 added, 0 changed, 0 removed
/home/oscar/current/active/sympy/sympy/plotting/series.py:73: UserWarning: The evaluation with NumPy/SciPy failed.
NameError: name 'SingularityFunction' is not defined
Trying to evaluate the expression with Sympy, but it might be a slow operation.
  warnings.warn(
/home/oscar/current/active/sympy/sympy/plotting/series.py:73: UserWarning: The evaluation with NumPy/SciPy failed.
NameError: name 'SingularityFunction' is not defined
Trying to evaluate the expression with Sympy, but it might be a slow operation.
  warnings.warn(
/home/oscar/current/active/sympy/sympy/plotting/series.py:73: UserWarning: The evaluation with NumPy/SciPy failed.
NameError: name 'SingularityFunction' is not defined
Trying to evaluate the expression with Sympy, but it might be a slow operation.
  warnings.warn(
/home/oscar/current/active/sympy/sympy/plotting/series.py:73: UserWarning: The evaluation with NumPy/SciPy failed.
NameError: name 'SingularityFunction' is not defined
Trying to evaluate the expression with Sympy, but it might be a slow operation.
  warnings.warn(
/home/oscar/current/active/sympy/sympy/plotting/series.py:73: UserWarning: The evaluation with NumPy/SciPy failed.
NameError: name 'SingularityFunction' is not defined
Trying to evaluate the expression with Sympy, but it might be a slow operation.
  warnings.warn(
/home/oscar/current/active/sympy/sympy/plotting/series.py:73: UserWarning: The evaluation with NumPy/SciPy failed.
NameError: name 'SingularityFunction' is not defined
Trying to evaluate the expression with Sympy, but it might be a slow operation.
  warnings.warn(
/home/oscar/current/active/sympy/sympy/plotting/series.py:73: UserWarning: The evaluation with NumPy/SciPy failed.
NameError: name 'SingularityFunction' is not defined
Trying to evaluate the expression with Sympy, but it might be a slow operation.
  warnings.warn(
/home/oscar/current/active/sympy/sympy/plotting/series.py:73: UserWarning: The evaluation with NumPy/SciPy failed.
NameError: name 'SingularityFunction' is not defined
Trying to evaluate the expression with Sympy, but it might be a slow operation.
  warnings.warn(
/home/oscar/current/active/sympy/sympy/plotting/series.py:73: UserWarning: The evaluation with NumPy/SciPy failed.
NameError: name 'SingularityFunction' is not defined
Trying to evaluate the expression with Sympy, but it might be a slow operation.
  warnings.warn(
/home/oscar/current/active/sympy/sympy/plotting/series.py:73: UserWarning: The evaluation with NumPy/SciPy failed.
NameError: name 'SingularityFunction' is not defined
Trying to evaluate the expression with Sympy, but it might be a slow operation.
  warnings.warn(
/home/oscar/current/active/sympy/sympy/plotting/series.py:73: UserWarning: The evaluation with NumPy/SciPy failed.
NameError: name 'SingularityFunction' is not defined
Trying to evaluate the expression with Sympy, but it might be a slow operation.
  warnings.warn(
/home/oscar/.pyenv/versions/3.11.3/lib/python3.11/importlib/__init__.py:126: SymPyDeprecationWarning: 

The sympy.testing.randtest submodule is deprecated. Use sympy.core.random instead.

See https://docs.sympy.org/latest/explanation/active-deprecations.html#deprecated-sympy-testing-randtest
for details.

This has been deprecated since SymPy version 1.10. It
will be removed in a future version of SymPy.

  return _bootstrap._gcd_import(name[level:], package, level)
reading sources... [100%] tutorials/intro-tutorial/solvers
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
                  copying downloadable files... [  0%] ../_build/plot_directive/guides/physics/generacopying downloadable files... [  1%] ../_build/plot_directive/guides/physics/generate_plots_q3_3.hirecopying downloadable files... [  2%] ../_build/plot_directive/guides/physics/generate_plots_q3_4.hirecopying downloadable files... [  2%] ../_build/plot_directive/guides/physics/generate_plots_q3_5_1.pncopying downloadable files... [  3%] ../_build/plot_directive/guides/physics/generate_plots_q3_5_1.hicopying downloadable files... [  3%] ../_build/plot_directive/guides/physics/generate_plots_q3_5_1.pdcopying downloadable files... [  4%] ../_build/plot_directive/guides/physics/generate_plots_q3_5_2.pncopying downloadable files... [  4%] ../_build/plot_directive/guides/physics/generate_plots_q3_5_2.hicopying downloadable files... [  4%] ../_build/plot_directive/guides/physics/generate_plots_q3_5_2.pdcopying downloadable files... [  5%] ../_build/plot_directive/guides/physics/generate_plots_q5.hires.copying downloadable files... [ 33%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 33%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 34%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 34%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 34%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 35%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 35%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 35%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 36%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 36%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 36%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 37%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 37%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 38%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 38%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 38%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 39%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 39%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 39%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 40%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 40%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 40%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 41%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 41%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 41%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 42%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 42%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 42%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 43%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 43%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 44%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 44%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 44%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 45%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 45%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 45%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 46%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 46%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 46%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 47%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 47%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 47%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 48%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 48%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 48%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 49%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 49%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 49%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 50%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 50%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 51%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 51%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 51%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 52%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 52%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 52%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 53%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 53%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 53%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 54%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 54%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 54%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 55%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 55%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 55%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 56%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 56%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 56%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 57%] ../_build/plot_directive/modules/physics/continuum_mechanics/beacopying downloadable files... [ 57%] ../_build/plot_directive/modules/physics/continuum_mechanics/trucopying downloadable files... [ 58%] ../_build/plot_directive/modules/physics/continuum_mechanics/trucopying downloadable files... [ 58%] ../_build/plot_directive/modules/physics/continuum_mechanics/trucopying downloadable files... [ 58%] ../_build/plot_directive/modules/physics/control/control_plots-1copying downloadable files... [ 59%] ../_build/plot_directive/modules/physics/control/control_plots-1copying downloadable files... [ 59%] ../_build/plot_directive/modules/physics/control/control_plots-1copying downloadable files... [ 59%] ../_build/plot_directive/modules/physics/control/control_plots-2copying downloadable files... [ 60%] ../_build/plot_directive/modules/physics/control/control_plots-2copying downloadable files... [ 60%] ../_build/plot_directive/modules/physics/control/control_plots-2copying downloadable files... [ 60%] ../_build/plot_directive/modules/physics/control/control_plots-3copying downloadable files... [ 61%] ../_build/plot_directive/modules/physics/control/control_plots-3copying downloadable files... [ 61%] ../_build/plot_directive/modules/physics/control/control_plots-3copying downloadable files... [ 61%] ../_build/plot_directive/modules/physics/control/control_plots-4copying downloadable files... [ 62%] ../_build/plot_directive/modules/physics/control/control_plots-4copying downloadable files... [ 62%] ../_build/plot_directive/modules/physics/control/control_plots-4copying downloadable files... [ 62%] ../_build/plot_directive/modules/physics/control/control_plots-5copying downloadable files... [ 63%] ../_build/plot_directive/modules/physics/control/control_plots-5copying downloadable files... [ 63%] ../_build/plot_directive/modules/physics/control/control_plots-5copying downloadable files... [100%] ../_build/plot_directive/modules/series/fourier-2.pdf
copying static files... done
copying extra files... done
done
writing output... [  0%] citing
Extension error (furo):
Handler <function _html_page_context at 0x7fc38cf387c0> for event 'html-page-context' threw an exception (exception: _CascadingStyleSheet is immutable)
make[1]: *** [Makefile:69: _html] Error 2
The docs build failed with the following errors:

Extension error (furo):
Handler <function _html_page_context at 0x7fc38cf387c0> for event 'html-page-context' threw an exception (exception: _CascadingStyleSheet is immutable)
make[1]: *** [Makefile:77: printwarnings] Error 1
make: *** [Makefile:58: html] Error 2

Obviously most of those warnings are not relevant to Sphinx.

If you want to try it yourself then it is just:

git clone https://github.com/sympy/sympy
cd sympy/doc
pip install -r requirements.txt
make html

AA-Turner · 2023-08-17T18:42:43Z

I've tried locally and can't reproduce -- could you run pip list please? I wonder if you have a local version of Furo older than 2023.07.26, which might be trying to alter the CSS filename?

A

oscarbenjamin · 2023-08-17T19:28:02Z

I wonder if you have a local version of Furo older than 2023.07.26,

Yes. The full pip list is a bit long but:

$ pip list | grep furo
furo                          2023.5.20

So, probably that was the problem. Trying now with furo 2023.7.26

oscarbenjamin · 2023-08-17T19:47:36Z

Trying now with furo 2023.7.26

Yep, that fixed it.

Thanks for the help!

AA-Turner · 2023-08-17T19:48:44Z

Wonderful, thank you for initially reporting the problem!

A

AA-Turner added 9 commits July 28, 2023 20:33

Add :no-contents-entry:

41a603f

Add :no-index-entry:

9cb755f

Add :no-index:

1e941d3

Add :no-index:

d8341af

Add :no-index:

b83e3b2

Add :no-index:

be11251

Support attributes with - in assert_node()

e80258d

line length

9d54226

line length

b170ef7

AA-Turner merged commit 1cfb68d into sphinx-doc:master Jul 28, 2023

AA-Turner deleted the obj-desc-options branch August 7, 2023 21:28

AA-Turner added this to the 7.2.0 milestone Aug 11, 2023

AA-Turner added a commit that referenced this pull request Aug 16, 2023

Add CHANGES entry for GH-11533

ddf8a8e

oscarbenjamin mentioned this pull request Aug 17, 2023

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

Open

oscarbenjamin mentioned this pull request Aug 17, 2023

Unpin sphinx sympy/sympy#25543

Merged

ankith26 mentioned this pull request Aug 19, 2023

Sphinx 7.2 breaks generated documentation headers #11618

Closed

github-actions bot locked as resolved and limited conversation to collaborators Sep 17, 2023

Uh oh!

Conversation

AA-Turner commented Jul 28, 2023

Uh oh!

picnixz commented Jul 29, 2023

Uh oh!

oscarbenjamin commented Aug 17, 2023

Uh oh!

AA-Turner commented Aug 17, 2023

Uh oh!

oscarbenjamin commented Aug 17, 2023

Uh oh!

AA-Turner commented Aug 17, 2023

Uh oh!

oscarbenjamin commented Aug 17, 2023

Uh oh!

oscarbenjamin commented Aug 17, 2023

Uh oh!

AA-Turner commented Aug 17, 2023

Uh oh!

oscarbenjamin commented Aug 17, 2023

Uh oh!

oscarbenjamin commented Aug 17, 2023

Uh oh!

AA-Turner commented Aug 17, 2023

Uh oh!

oscarbenjamin commented Aug 17, 2023

Uh oh!

oscarbenjamin commented Aug 17, 2023

Uh oh!

AA-Turner commented Aug 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants