Skip to content

BUG: RTD build is broken with astropy 7.1 #3326

Closed

Activity

  1. bsipocz commented on May 28, 2025

    @bsipocz
    MemberAuthor

    The relevant warnings:

    /home/docs/checkouts/readthedocs.org/user_builds/astroquery/envs/latest/lib/python3.11/site-packages/astropy/config/configuration.py:docstring of astropy.config.configuration.ConfigNamespace.items:1: WARNING: py:class reference target not found: ConfigItem [ref.class]
    /home/docs/checkouts/readthedocs.org/user_builds/astroquery/envs/latest/lib/python3.11/site-packages/astropy/config/configuration.py:docstring of astropy.config.configuration.ConfigNamespace.values:1: WARNING: py:class reference target not found: ConfigItem [ref.class]
    /home/docs/checkouts/readthedocs.org/user_builds/astroquery/envs/latest/lib/python3.11/site-packages/astropy/config/configuration.py:docstring of astropy.config.configuration.ConfigNamespace.items:1: WARNING: py:class reference target not found: ConfigItem [ref.class]
    /home/docs/checkouts/readthedocs.org/user_builds/astroquery/envs/latest/lib/python3.11/site-packages/astropy/config/configuration.py:docstring of astropy.config.configuration.ConfigNamespace.values:1: WARNING: py:class reference target not found: ConfigItem [ref.class]
    /home/docs/checkouts/readthedocs.org/user_builds/astroquery/envs/latest/lib/python3.11/site-packages/astropy/config/configuration.py:docstring of astropy.config.configuration.ConfigNamespace.items:1: WARNING: py:class reference target not found: ConfigItem [ref.class]
    /home/docs/checkouts/readthedocs.org/user_builds/astroquery/envs/latest/lib/python3.11/site-packages/astropy/config/configuration.py:docstring of astropy.config.configuration.ConfigNamespace.values:1: WARNING: py:class reference target not found: ConfigItem [ref.class]
    
  2. bsipocz commented on May 28, 2025

    @bsipocz
    MemberAuthor

    Reverting the type hinting stuff from the upstream config codebase actually solves these....

    (during docs build when we hit :inherited-members: we pull in the upstream Configitem refs that doesn't intersphinx resolve. Pretty annoying, especially we get zero benefit, only the annoyance here from all these typing stuff)

    diff --git a/astropy/config/configuration.py b/astropy/config/configuration.py
    index b7de74d668..dca4a87ec6 100644
    --- a/astropy/config/configuration.py
    +++ b/astropy/config/configuration.py
    @@ -90,7 +90,7 @@ class ConfigNamespace(metaclass=_ConfigNamespaceMeta):
         """
         A namespace of configuration items.  Each subpackage with
         configuration items should define a subclass of this class,
    -    containing `ConfigItem` instances as members.
    +    containing `~astropy.config.ConfigItem` instances as members.
     
         For example::
     
    @@ -121,13 +121,13 @@ class ConfigNamespace(metaclass=_ConfigNamespaceMeta):
         keys = __iter__
         """Iterate over configuration item names."""
     
    -    def values(self) -> Generator[ConfigItem, None, None]:
    +    def values(self):
             """Iterate over configuration item values."""
             for val in self.__class__.__dict__.values():
                 if isinstance(val, ConfigItem):
                     yield val
     
    -    def items(self) -> Generator[tuple[str, ConfigItem], None, None]:
    +    def items(self):
             """Iterate over configuration item ``(name, value)`` pairs."""
             for key, val in self.__class__.__dict__.items():
                 if isinstance(val, ConfigItem):
    
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions