Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Closed
pllim opened this issue May 10, 2021 · 7 comments · Fixed by #14140
Closed

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

pllim opened this issue May 10, 2021 · 7 comments · Fixed by #14140
Labels
Docs Upstream Fix Required

Comments

@pllim
Copy link
Member

pllim commented May 10, 2021 •
edited

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 .

astropy/setup.cfg

Line 103 in f6569ce

Jinja2<3.1

@pllim pllim added this to the v5.0 milestone May 10, 2021
@astrojuanlu
Copy link
Member

Looks like Sphinx 4.0.2 will be released with this fix!

@pllim
Copy link
Member Author

pllim commented May 17, 2021

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

@pllim pllim changed the title DOC: Unpin max version of Sphinx DOC: Unpin max version of Sphinx when Sphinx 4.0.2 is out May 17, 2021
@pllim pllim mentioned this issue May 20, 2021
Closed
@pllim pllim removed this from the v5.0 milestone May 20, 2021
@pllim pllim mentioned this issue Aug 2, 2021
Merged
@saimn saimn mentioned this issue Oct 21, 2021
Closed
9 tasks
@pllim pllim mentioned this issue Mar 24, 2022
Closed
@pllim pllim 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) Mar 24, 2022
@WilliamJamieson
Copy link
Contributor

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

@pllim pllim mentioned this issue Mar 30, 2022
Closed
10 tasks
@saimn saimn mentioned this issue Apr 1, 2022
Closed
10 tasks
@kniklas kniklas mentioned this issue Apr 13, 2022
Closed
@ayshih ayshih mentioned this issue Jun 19, 2022
Closed
2 tasks
@eerovaher
Copy link
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.

@pllim
Copy link
Member Author

pllim commented Aug 30, 2022

@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.

@eerovaher
Copy link
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.

@pllim
Copy link
Member Author

pllim commented Aug 30, 2022

@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!

astropy/.readthedocs.yml

Line 8 in d15a689

python: "3.9"

@eerovaher eerovaher mentioned this issue Aug 30, 2022
Closed
10 tasks
@adam-grant-hendry adam-grant-hendry mentioned this issue Oct 18, 2022
Open
adam-grant-hendry added a commit to adam-grant-hendry/qtpygraph that referenced this issue Oct 25, 2022
@adam-grant-hendry
🐛 fix(pyproject.toml): pin dependencies
605149e 
Pin `sphinx` dependencies. Also do not pin major versions.

See: astropy/astropy#11725
adam-grant-hendry added a commit to adam-grant-hendry/qtpygraph that referenced this issue Oct 25, 2022
@adam-grant-hendry
🐛 fix(pyproject.toml): re-pin Sphinx and Jinja2
78cd756 
See: astropy/astropy#11725
adam-grant-hendry added a commit to adam-grant-hendry/qtpygraph that referenced this issue Oct 25, 2022
@adam-grant-hendry
🐛 fix(pyproject): re-pin Sphinx and Jinja2
30dec06 
See: astropy/astropy#11725
adam-grant-hendry added a commit to adam-grant-hendry/qtpygraph that referenced this issue Oct 26, 2022
@adam-grant-hendry
Create Documenation in GitHub Pages (#9)
7f43ce8 
* 📚 docs(conf.py): update theme

Use `sphinx-book-theme`.

* 🤖 ci(docs.yml): create docs gh action

* 🐛 fix(pyproject.toml): pin dependencies

Pin `sphinx` dependencies. Also do not pin major versions.

See: astropy/astropy#11725

* 🐛 fix(docs): specify `sphinx-book-theme`

Forgot to specify `sphinx-book-them` in `conf.py`.

* 🐛 fix(pyproject): re-pin `Sphinx` and `Jinja2`

See: astropy/astropy#11725

* 🐛 fix(.gitignore): add `logs/`
adam-grant-hendry added a commit to adam-grant-hendry/qtpygraph that referenced this issue Oct 26, 2022
@adam-grant-hendry
📚 docs: create GitHub Pages
eeeedfb 
- Use `sphinx-book-theme`.
- Pin `sphinx` dependencies.

See: astropy/astropy#11725
adam-grant-hendry added a commit to adam-grant-hendry/qtpygraph that referenced this issue Oct 26, 2022
@adam-grant-hendry
📚 docs: create GitHub Pages
a8ea9b9 
- Use `sphinx-book-theme`.
- Pin `sphinx` dependencies.

See: astropy/astropy#11725
@pllim pllim mentioned this issue Dec 1, 2022
Open
@saimn saimn mentioned this issue Dec 2, 2022
Closed
@pllim pllim mentioned this issue Dec 6, 2022
Merged
10 tasks
@saimn saimn mentioned this issue Dec 6, 2022
Closed
@mhvk mhvk mentioned this issue Dec 7, 2022
Merged
10 tasks
adam-grant-hendry added a commit to adam-grant-hendry/qtpygraph that referenced this issue Jul 19, 2023
@adam-grant-hendry
🐛 fix(pyproject.toml): unpin Sphinx and Jinja2 dependencies
4328f3e 
Originally related to astropy/astropy#11725, this has since been fixed.
adam-grant-hendry added a commit to adam-grant-hendry/qtpygraph that referenced this issue Jul 19, 2023
@adam-grant-hendry
🐛 fix(pyproject.toml): unpin Sphinx and Jinja2 dependencies
16ef692 
Originally related to astropy/astropy#11725, this has since been fixed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs Upstream Fix Required
Projects
None yet
Milestone
No milestone
4 participants
@astrojuanlu @pllim @WilliamJamieson @eerovaher