Skip to content

[DO NOT MERGE] Debugging docs on Sphinx 4 - #1238

Closed
astrojuanlu wants to merge 3 commits into
astropy:mainfrom
astrojuanlu:debug-docs
Closed

astrojuanlu wants to merge 3 commits into
astropy:mainfrom
astrojuanlu:debug-docs

Conversation

@astrojuanlu

@astrojuanlu astrojuanlu commented Sep 7, 2021 •

Copy link
Copy Markdown
Member

@astrojuanlu

astrojuanlu commented Sep 7, 2021 •

Copy link
Copy Markdown
Member Author

From the reduced version, this is the diff that makes the warning disappear:

commit 31fbd78c6f038a1d2b54123cf43c09362523b919
Author: Juan Luis Cano Rodríguez <[email protected]>
Date:   Tue Sep 7 12:11:42 2021 +0200

    Fix docs

diff --git a/docs/index.rst b/docs/index.rst
index 2759c333..acedfe08 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -43,7 +43,6 @@ User Documentation
 .. toctree::
     :maxdepth: 1
 
-    psf.rst
     psf_matching.rst
 
 

Therefore, my best guess at the moment is that the conflicting classes are now being exported twice, one in

photutils/docs/psf.rst

Lines 685 to 686 in 1948ff0

.. automodapi:: photutils.psf
:no-heading:

and another one in

.. automodapi:: photutils.psf.matching
:no-heading:

It took me a while to get here. Luckily, pydeps help me identify that photutils.psf.matching is mostly independent from the rest.

If no one else makes progress on this, I'll come back in a few days.

@pllim

pllim commented Sep 7, 2021

Copy link
Copy Markdown
Member

This assessment is consistent of what @larrybradley reported in astropy/astropy#11723 (comment) .

However, the solution besides refactoring existing imports (not desirable if can be avoided) is unclear.

@larrybradley larrybradley added DO-NOT-MERGE Not ready to merge, even if CI passes docs Changes to the narrative docs, README, or CONTRIBUTING labels Sep 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DO-NOT-MERGE Not ready to merge, even if CI passes docs Changes to the narrative docs, README, or CONTRIBUTING

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants