Skip to content

Fix Sphinx warnings about duplicate objects - #1306

Merged
larrybradley merged 2 commits into
astropy:mainfrom
larrybradley:sphinx-duplicates
Mar 12, 2022
Merged

larrybradley merged 2 commits into
astropy:mainfrom
larrybradley:sphinx-duplicates

Conversation

@larrybradley

Copy link
Copy Markdown
Member

Starting with Sphinx 4.0, when building the docs warnings were issued about duplicate objects for the psf.matching functions. psf.__init__ is importing all from psf.matching, and I think Sphinx is getting confused by seeing these tools both as psf.<tool> and psf.matching.<tool>.

I don't know if this is the best solution, but explicitly removing the psf.matching tools from psf.__all__ seems to solve the issue.

Closes #1238

@larrybradley larrybradley added docs Changes to the narrative docs, README, or CONTRIBUTING no-changelog-entry-needed No CHANGES.rst entry required (read by the changelog check) labels Mar 12, 2022
@larrybradley larrybradley added this to the 1.4.0 milestone Mar 12, 2022
@pep8speaks

pep8speaks commented Mar 12, 2022 •

Copy link
Copy Markdown

Hello @larrybradley! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2022-03-12 00:42:36 UTC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Changes to the narrative docs, README, or CONTRIBUTING no-changelog-entry-needed No CHANGES.rst entry required (read by the changelog check)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants