Skip to content

DOC: Allow Sphinx 4.0.2 or greater#11763

Closed
pllim wants to merge 1 commit intoastropy:mainfrom
pllim:unpin-sphinx
Closed

DOC: Allow Sphinx 4.0.2 or greater#11763
pllim wants to merge 1 commit intoastropy:mainfrom
pllim:unpin-sphinx

Conversation

@pllim
Copy link
Member

@pllim pllim commented May 20, 2021

Description

Fix #11725, follow-up of #11724 now that Sphinx 4.0.2 is out (sphinx-doc/sphinx#9214).

@pllim pllim added this to the v5.0 milestone May 20, 2021
@pllim

This comment has been minimized.

@pllim pllim requested review from astrojuanlu and saimn May 20, 2021 17:54
@pllim
Copy link
Member Author

pllim commented May 20, 2021

Now I see a lot of warnings similar to this one:

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

@larrybradley , didn't you say you encountered the same thing in photutils? How did you fix it?

@larrybradley
Copy link
Member

I didn't fix it. I just pinned Sphinx < 4 to stop the warnings. As I already noted in #11723 (comment), the Sphinx updates did not fix this issue (this is the same issue you reported in #11723).

I don't know if this a Sphinx bug or if we need to update sphinx-automodapi to be compatible with Sphinx 4+.

@larrybradley
Copy link
Member

See #11723 (comment) for an explanation of the problem.

@pllim
Copy link
Member Author

pllim commented May 20, 2021

I am not sure if we have anyone with the time to dive into sphinx-automodapi. 😿

Opened astropy/sphinx-automodapi#130

@pllim pllim added the Upstream Action Required Was: Upstream Fix Required label May 20, 2021
@astrojuanlu
Copy link
Member

Probably not the place to ask this, but do you have any reading material on why sphinx-automodapi is used instad of sphinx-autoapi or plain autodoc?

@pllim
Copy link
Member Author

pllim commented May 20, 2021

Re: why -- I don't know. We been using it for many years. My guess is we wanted things to look pretty but Sphinx didn't have pretty layout back then. Maybe @astrofrog, @eteq, or @embray remember the real reason.

@saimn
Copy link
Contributor

saimn commented May 20, 2021

sphinx-autoapi is a fairly recent project compared to sphinx-automodapi I think. The goal is probably about the same, automating the api generation without having to write the list of functions/classes with plain autodoc.

@pllim
Copy link
Member Author

pllim commented May 20, 2021

Even if we switch to sphinx-autoapi here in the core, downstream packages like photutils need to switch too. It is going to be a big project.

@astrojuanlu
Copy link
Member

Sure thing, didn't want to imply a migration just yet - only working to understand the possible overlap between the two :)

@github-actions
Copy link
Contributor

Hi humans 👋 - this pull request hasn't had any new commits for approximately 4 months. I plan to close this in 30 days if the pull request doesn't have any new commits by then.

In lieu of a stalled pull request, please consider closing this and open an issue instead if a reminder is needed to revisit in the future. Maintainers may also choose to add keep-open label to keep this PR open but it is discouraged unless absolutely necessary.

If this PR still needs to be reviewed, as an author, you can rebase it to reset the clock.

If you believe I commented on this pull request incorrectly, please report this here.

@github-actions github-actions bot added the Close? Tell stale bot that this issue/PR is stale label Oct 19, 2021
@saimn saimn mentioned this pull request Oct 21, 2021
9 tasks
@pllim
Copy link
Member Author

pllim commented Oct 21, 2021

Superseded by #12270

@pllim pllim closed this Oct 21, 2021
@pllim pllim deleted the unpin-sphinx branch October 21, 2021 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Close? Tell stale bot that this issue/PR is stale Docs installation no-changelog-entry-needed Upstream Action Required Was: Upstream Fix Required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: Unpin max version of Sphinx when Sphinx 4.0.2 is out (and Jinja2)

4 participants