Skip to content

DOC: Warnings about duplicate object description of astropy.coordinates.builtin_frames #11723

New issue
New issue
Closed
#14140
Closed
DOC: Warnings about duplicate object description of astropy.coordinates.builtin_frames#11723
#14140
Labels
BugDocscoordinates

Description

@pllim
pllim
opened on May 10, 2021

I started seeing these warnings in RTD. Is this related to the recent doc refactoring, @nstarman , @adrn , or @mhvk ?

.../astropy/coordinates/builtin_frames/galactic.py:docstring of astropy.coordinates.builtin_frames.galactic.Galactic:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.galactic.Galactic, other instance in api/astropy.coordinates.Galactic, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/lsr.py:docstring of astropy.coordinates.builtin_frames.lsr.GalacticLSR:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.lsr.GalacticLSR, other instance in api/astropy.coordinates.GalacticLSR, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/galactocentric.py:docstring of astropy.coordinates.builtin_frames.galactocentric.Galactocentric:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.galactocentric.Galactocentric, other instance in api/astropy.coordinates.Galactocentric, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/ecliptic.py:docstring of astropy.coordinates.builtin_frames.ecliptic.GeocentricMeanEcliptic:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.ecliptic.GeocentricMeanEcliptic, other instance in api/astropy.coordinates.GeocentricMeanEcliptic, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/ecliptic.py:docstring of astropy.coordinates.builtin_frames.ecliptic.GeocentricTrueEcliptic:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.ecliptic.GeocentricTrueEcliptic, other instance in api/astropy.coordinates.GeocentricTrueEcliptic, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/hcrs.py:docstring of astropy.coordinates.builtin_frames.hcrs.HCRS:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.hcrs.HCRS, other instance in api/astropy.coordinates.HCRS, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/ecliptic.py:docstring of astropy.coordinates.builtin_frames.ecliptic.HeliocentricEclipticIAU76:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.ecliptic.HeliocentricEclipticIAU76, other instance in api/astropy.coordinates.HeliocentricEclipticIAU76, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/ecliptic.py:docstring of astropy.coordinates.builtin_frames.ecliptic.HeliocentricMeanEcliptic:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.ecliptic.HeliocentricMeanEcliptic, other instance in api/astropy.coordinates.HeliocentricMeanEcliptic, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/ecliptic.py:docstring of astropy.coordinates.builtin_frames.ecliptic.HeliocentricTrueEcliptic:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.ecliptic.HeliocentricTrueEcliptic, other instance in api/astropy.coordinates.HeliocentricTrueEcliptic, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/icrs.py:docstring of astropy.coordinates.builtin_frames.icrs.ICRS:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.icrs.ICRS, other instance in api/astropy.coordinates.ICRS, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/itrs.py:docstring of astropy.coordinates.builtin_frames.itrs.ITRS:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.itrs.ITRS, other instance in api/astropy.coordinates.ITRS, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/lsr.py:docstring of astropy.coordinates.builtin_frames.lsr.LSR:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.lsr.LSR, other instance in api/astropy.coordinates.LSR, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/lsr.py:docstring of astropy.coordinates.builtin_frames.lsr.LSRD:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.lsr.LSRD, other instance in api/astropy.coordinates.LSRD, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/lsr.py:docstring of astropy.coordinates.builtin_frames.lsr.LSRK:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.lsr.LSRK, other instance in api/astropy.coordinates.LSRK, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/gcrs.py:docstring of astropy.coordinates.builtin_frames.gcrs.PrecessedGeocentric:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.gcrs.PrecessedGeocentric, other instance in api/astropy.coordinates.PrecessedGeocentric, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/skyoffset.py:docstring of astropy.coordinates.builtin_frames.skyoffset.SkyOffsetFrame:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.skyoffset.SkyOffsetFrame, other instance in api/astropy.coordinates.SkyOffsetFrame, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/supergalactic.py:docstring of astropy.coordinates.builtin_frames.supergalactic.Supergalactic:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.supergalactic.Supergalactic, other instance in api/astropy.coordinates.Supergalactic, use :noindex: for one of them
.../astropy/coordinates/builtin_frames/equatorial.py:docstring of astropy.coordinates.builtin_frames.equatorial.TEME:1: WARNING: duplicate object description of astropy.coordinates.builtin_frames.equatorial.TEME, other instance in api/astropy.coordinates.TEME, use :noindex: for one of them

Activity

  1. pllim
    added
    Docs
    Bug
    coordinates
    on May 10, 2021

  2. adrn commented on May 10, 2021

    @adrn
    adrn
    on May 10, 2021
    Member

    Hm, I don't think so - this looks like a potential automodapi issue?

  3. pllim commented on May 10, 2021

    @pllim
    pllim
    on May 10, 2021
    MemberAuthor

    Hmm... Maybe it is a red herring. I don't see it in #11724 . Sorry for the noise.

  4. pllim
    closed this as completedon May 10, 2021

  5. larrybradley commented on May 11, 2021

    @larrybradley
    larrybradley
    on May 11, 2021
    Member

    I think this is a real issue. I'm getting this same error in photutils. It appears to be due to submodules of submodules:

    mod1
    __init__.py  (from mod2 import *)
    mod2
       __init__.py (from a import *)
       a.py (defines myfunc, and __all__ = ['myfunc'])

    In this case, Sphinx is now defining duplicate references as:
    package.mod1.myfunc and package.mod1.mod2.myfunc and raising the
    "duplicate object descriptions".

    This started with Sphinx 4 release. Not sure if this was an unintended bug there or if something needs to be fixed in astropy-sphinx for compatiblity with Sphinx 4. @astrojuanlu ?

  6. larrybradley
    reopened this on May 11, 2021

  7. astrojuanlu commented on May 11, 2021

    @astrojuanlu
    astrojuanlu
    on May 11, 2021
    Member

    @larrybradley what do you mean by astropy-sphinx exactly?

    Also, I went to the last photutils build https://readthedocs.org/projects/photutils/builds/13703740/ and it ran Sphinx v3.5.4 (Sphinx 4 was released two days later). If you open a new PR and observe this warning there, feel free to ping me.

    Also, if this is because Sphinx 4, I guess it's natural that it doesn't appear in #11724, right? We'd have to wait until Sphinx 4.0.2 is released with a fix for sphinx-doc/sphinx#9210 to unpin the version and see if this happens again.

  8. larrybradley commented on May 11, 2021

    @larrybradley
    larrybradley
    on May 11, 2021
    Member

    It was the nightly photutils cron job last night: https://github.com/astropy/photutils/runs/2552715843?check_suite_focus=true

    And I can reproduce this locally.

    Sorry, I had them reversed. It's sphinx-astropy: https://github.com/astropy/sphinx-astropy, which photutils and astropy use.

    EDIT: and particular: https://github.com/astropy/sphinx-automodapi

  9. larrybradley commented on May 11, 2021

    @larrybradley
    larrybradley
    on May 11, 2021
    Member

    @astrojuanlu I just tried locally with the current Sphinx 4.x dev branch (https://github.com/sphinx-doc/sphinx/commits/4.x) and I still get the same warnings.

  10. pllim commented on May 20, 2021

    @pllim
    pllim
    on May 20, 2021
    MemberAuthor

    Opened astropy/sphinx-automodapi#130

  11. mhvk
    closed this as completedin #14140on Dec 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    BugDocscoordinates

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions