Sphinx test fails for myst-parser 0.18.0, works with myst-parser 0.17.2

[eagleoflqj]

This makes every PR fail.

[asmeurer]

These are the warnings

docstring of sympy.polys.domains.field.Field.is_Field:14: WARNING: more than one target found for cross-reference 'is_Ring': sympy.polys.domains.domain.Domain.is_Ring, sympy.polys.domains.ring.Ring.is_Ring
docstring of sympy.polys.domains.field.Field.is_Field:14: WARNING: more than one target found for cross-reference 'has_assoc_Field': sympy.polys.domains.domain.Domain.has_assoc_Field, sympy.polys.domains.FiniteField.has_assoc_Field, sympy.polys.domains.IntegerRing.has_assoc_Field, sympy.polys.domains.RationalField.has_assoc_Field, sympy.polys.domains.AlgebraicField.has_assoc_Field, sympy.polys.domains.RealField.has_assoc_Field, sympy.polys.domains.ComplexField.has_assoc_Field, sympy.polys.domains.PolynomialRing.has_assoc_Field, sympy.polys.domains.FractionField.has_assoc_Field, sympy.polys.domains.ExpressionDomain.has_assoc_Field
docstring of sympy.polys.domains.ring.Ring.is_Ring:15: WARNING: more than one target found for cross-reference 'is_PID': sympy.polys.domains.domain.Domain.is_PID, sympy.polys.domains.field.Field.is_PID, sympy.polys.domains.IntegerRing.is_PID, sympy.polys.domains.RealField.is_PID
docstring of sympy.polys.domains.ring.Ring.is_Ring:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.ring.Ring.is_Ring:15: WARNING: more than one target found for cross-reference 'has_assoc_Ring': sympy.polys.domains.domain.Domain.has_assoc_Ring, sympy.polys.domains.FiniteField.has_assoc_Ring, sympy.polys.domains.IntegerRing.has_assoc_Ring, sympy.polys.domains.RationalField.has_assoc_Ring, sympy.polys.domains.AlgebraicField.has_assoc_Ring, sympy.polys.domains.RealField.has_assoc_Ring, sympy.polys.domains.ComplexField.has_assoc_Ring, sympy.polys.domains.PolynomialRing.has_assoc_Ring, sympy.polys.domains.FractionField.has_assoc_Ring, sympy.polys.domains.ExpressionDomain.has_assoc_Ring
docstring of sympy.polys.domains.FiniteField.has_assoc_Field:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.FiniteField.has_assoc_Ring:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.FiniteField.has_assoc_Ring:15: WARNING: more than one target found for cross-reference 'get_ring': sympy.polys.domains.domain.Domain.get_ring, sympy.polys.domains.field.Field.get_ring, sympy.polys.domains.ring.Ring.get_ring, sympy.polys.domains.RationalField.get_ring, sympy.polys.domains.GMPYRationalField.get_ring, sympy.polys.domains.gaussiandomains.GaussianIntegerRing.get_ring, sympy.polys.domains.gaussiandomains.GaussianRationalField.get_ring, sympy.polys.domains.AlgebraicField.get_ring, sympy.polys.domains.RealField.get_ring, sympy.polys.domains.ComplexField.get_ring, sympy.polys.domains.FractionField.get_ring, sympy.polys.domains.ExpressionDomain.get_ring
docstring of sympy.polys.domains.IntegerRing.has_assoc_Field:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.IntegerRing.has_assoc_Ring:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.IntegerRing.has_assoc_Ring:15: WARNING: more than one target found for cross-reference 'get_ring': sympy.polys.domains.domain.Domain.get_ring, sympy.polys.domains.field.Field.get_ring, sympy.polys.domains.ring.Ring.get_ring, sympy.polys.domains.RationalField.get_ring, sympy.polys.domains.GMPYRationalField.get_ring, sympy.polys.domains.gaussiandomains.GaussianIntegerRing.get_ring, sympy.polys.domains.gaussiandomains.GaussianRationalField.get_ring, sympy.polys.domains.AlgebraicField.get_ring, sympy.polys.domains.RealField.get_ring, sympy.polys.domains.ComplexField.get_ring, sympy.polys.domains.FractionField.get_ring, sympy.polys.domains.ExpressionDomain.get_ring
docstring of sympy.polys.domains.IntegerRing.is_PID:16: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.RationalField.has_assoc_Field:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.RationalField.has_assoc_Field:15: WARNING: more than one target found for cross-reference 'get_field': sympy.polys.domains.domain.Domain.get_field, sympy.polys.domains.field.Field.get_field, sympy.polys.domains.FiniteField.get_field, sympy.polys.domains.IntegerRing.get_field, sympy.polys.domains.gaussiandomains.GaussianIntegerRing.get_field, sympy.polys.domains.gaussiandomains.GaussianRationalField.get_field, sympy.polys.domains.PolynomialRing.get_field, sympy.polys.domains.ExpressionDomain.get_field
docstring of sympy.polys.domains.RationalField.has_assoc_Ring:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.AlgebraicField.has_assoc_Field:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.AlgebraicField.has_assoc_Field:15: WARNING: more than one target found for cross-reference 'get_field': sympy.polys.domains.domain.Domain.get_field, sympy.polys.domains.field.Field.get_field, sympy.polys.domains.FiniteField.get_field, sympy.polys.domains.IntegerRing.get_field, sympy.polys.domains.gaussiandomains.GaussianIntegerRing.get_field, sympy.polys.domains.gaussiandomains.GaussianRationalField.get_field, sympy.polys.domains.PolynomialRing.get_field, sympy.polys.domains.ExpressionDomain.get_field
docstring of sympy.polys.domains.AlgebraicField.has_assoc_Ring:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.RealField.has_assoc_Field:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.RealField.has_assoc_Field:15: WARNING: more than one target found for cross-reference 'get_field': sympy.polys.domains.domain.Domain.get_field, sympy.polys.domains.field.Field.get_field, sympy.polys.domains.FiniteField.get_field, sympy.polys.domains.IntegerRing.get_field, sympy.polys.domains.gaussiandomains.GaussianIntegerRing.get_field, sympy.polys.domains.gaussiandomains.GaussianRationalField.get_field, sympy.polys.domains.PolynomialRing.get_field, sympy.polys.domains.ExpressionDomain.get_field
docstring of sympy.polys.domains.RealField.has_assoc_Ring:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.RealField.is_PID:16: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.RealField.is_PID:16: WARNING: more than one target found for cross-reference 'get_field': sympy.polys.domains.domain.Domain.get_field, sympy.polys.domains.field.Field.get_field, sympy.polys.domains.FiniteField.get_field, sympy.polys.domains.IntegerRing.get_field, sympy.polys.domains.gaussiandomains.GaussianIntegerRing.get_field, sympy.polys.domains.gaussiandomains.GaussianRationalField.get_field, sympy.polys.domains.PolynomialRing.get_field, sympy.polys.domains.ExpressionDomain.get_field
docstring of sympy.polys.domains.ComplexField.has_assoc_Field:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.ComplexField.has_assoc_Field:15: WARNING: more than one target found for cross-reference 'get_field': sympy.polys.domains.domain.Domain.get_field, sympy.polys.domains.field.Field.get_field, sympy.polys.domains.FiniteField.get_field, sympy.polys.domains.IntegerRing.get_field, sympy.polys.domains.gaussiandomains.GaussianIntegerRing.get_field, sympy.polys.domains.gaussiandomains.GaussianRationalField.get_field, sympy.polys.domains.PolynomialRing.get_field, sympy.polys.domains.ExpressionDomain.get_field
docstring of sympy.polys.domains.ComplexField.has_assoc_Ring:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.PolynomialRing.has_assoc_Field:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.PolynomialRing.has_assoc_Ring:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.PolynomialRing.has_assoc_Ring:15: WARNING: more than one target found for cross-reference 'get_ring': sympy.polys.domains.domain.Domain.get_ring, sympy.polys.domains.field.Field.get_ring, sympy.polys.domains.ring.Ring.get_ring, sympy.polys.domains.RationalField.get_ring, sympy.polys.domains.GMPYRationalField.get_ring, sympy.polys.domains.gaussiandomains.GaussianIntegerRing.get_ring, sympy.polys.domains.gaussiandomains.GaussianRationalField.get_ring, sympy.polys.domains.AlgebraicField.get_ring, sympy.polys.domains.RealField.get_ring, sympy.polys.domains.ComplexField.get_ring, sympy.polys.domains.FractionField.get_ring, sympy.polys.domains.ExpressionDomain.get_ring
docstring of sympy.polys.domains.FractionField.has_assoc_Field:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.FractionField.has_assoc_Field:15: WARNING: more than one target found for cross-reference 'get_field': sympy.polys.domains.domain.Domain.get_field, sympy.polys.domains.field.Field.get_field, sympy.polys.domains.FiniteField.get_field, sympy.polys.domains.IntegerRing.get_field, sympy.polys.domains.gaussiandomains.GaussianIntegerRing.get_field, sympy.polys.domains.gaussiandomains.GaussianRationalField.get_field, sympy.polys.domains.PolynomialRing.get_field, sympy.polys.domains.ExpressionDomain.get_field
docstring of sympy.polys.domains.FractionField.has_assoc_Ring:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.ExpressionDomain.has_assoc_Field:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field
docstring of sympy.polys.domains.ExpressionDomain.has_assoc_Ring:15: WARNING: more than one target found for cross-reference 'is_Field': sympy.polys.domains.domain.Domain.is_Field, sympy.polys.domains.field.Field.is_Field

I don't understand where these warnings are coming from. It doesn't say what file is causing it. The things in question are attributes without documentation that don't seem to be referenced anywhere.

It might be a bug in MyST. For now let's just pin MyST to a lower version so that the tests stop failing until we can figure out what is causing this.

[oscarbenjamin]

I've given some explanation here:
sphinx-doc/sphinx#10538

Basically the Domain class has documented class attributes using attribute docstrings. Subclasses like Ring etc also set the attributes but since they don't use docstrings that doesn't show up in the docs. The update causes e.g. Ring.is_Ring to appear in the docs with the docstring inherited from Domain.is_Ring. Then there are multiple targets for is_Ring.

[oscarbenjamin]

I've also opened an issue with myst-parser:
executablebooks/MyST-Parser#583

[oscarbenjamin]

The problem is Sphinx rather than myst-parser. Changing myst-parser just means that you end up with a different version of Sphinx.

[asmeurer]

Ah, I thought this sounded more like a Sphinx (autodoc) bug than MyST. Does that mean that MyST pins Sphinx?

At any rate, let's pin Sphinx until this gets an upstream fix released.

[oscarbenjamin]

Yes, looks like it's going to get fixed upstream:
sphinx-doc/sphinx#10539

We should pin for now until there is a new release of Sphinx.