Skip to content

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

Closed

Description

@pllim

Update: If you want to build docs in Python 3.10 or newer, see the pins in #13587 .

Revert #11724 when sphinx-doc/sphinx#9210 is resolved. @saimn tracked it down to sphinx-doc/sphinx#8935 .

astropy/setup.cfg

Lines 84 to 85 in 642d8ae

docs =
sphinx<4

Also revert #12988 .

Jinja2<3.1

Activity

  1. added this to the v5.0 milestone on May 10, 2021
  2. astrojuanlu commented on May 11, 2021

    @astrojuanlu
    Member

    Looks like Sphinx 4.0.2 will be released with this fix!

  3. pllim commented on May 17, 2021

    @pllim
    MemberAuthor

    I have been following sphinx-doc/sphinx#9214 . I think it is happening by the end of the week.

  4. changed the title [-]DOC: Unpin max version of Sphinx[/-] [+]DOC: Unpin max version of Sphinx when Sphinx 4.0.2 is out[/+] on May 17, 2021
  5. removed this from the v5.0 milestone on May 20, 2021
  6. changed the title [-]DOC: Unpin max version of Sphinx when Sphinx 4.0.2 is out[/-] [+]DOC: Unpin max version of Sphinx when Sphinx 4.0.2 is out (and Jinja2)[/+] on Mar 24, 2022
  7. WilliamJamieson commented on Mar 24, 2022

    @WilliamJamieson
    Contributor

    Jinja2 pin is related to sphinx-doc/sphinx#10291

  8. eerovaher commented on Aug 29, 2022

    @eerovaher
    Member

    sphinx-doc/sphinx@7318d1d introduced code to sphinx 3.5 that ended up being incompatible with Python 3.10. The fix was provided by sphinx-doc/sphinx@8b2031c, but is available only for sphinx >= 4.2. Installing astropy[docs] currently results in sphinx 3.5.4 being installed. If the maximum version of sphinx can't be unpinned soon then it should lowered even further to < 3.5.

  9. pllim commented on Aug 30, 2022

    @pllim
    MemberAuthor

    @saimn was going to revisit this when he can but if you are in a rush, you can try use astropy/sphinx-automodapi#150 in this repo and debug the remaining errors.

  10. eerovaher commented on Aug 30, 2022

    @eerovaher
    Member

    For the time being I have installed sphinx 3.4.3. This does not address the underlying problems, but at least it enables building astropy docs with Python 3.10.

  11. pllim commented on Aug 30, 2022

    @pllim
    MemberAuthor

    @eerovaher , do you want to open a PR to lower the pin and also try to build RTD in Python 3.10 with it? Thanks!

    python: "3.9"

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