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

Building the docs fails #3022

Closed
ptsavol opened this issue Dec 3, 2024 · 1 comment
Closed

Building the docs fails #3022

ptsavol opened this issue Dec 3, 2024 · 1 comment
Assignees
@ptsavol
Labels
Docs

Comments

@ptsavol
Copy link
Member

ptsavol commented Dec 3, 2024

Read the Docs has failed in building the documentation for a couple of days now. The reason is probably related to new versions for sphinx dependencies.

Build succeeds with these:
pylint-3.3.1
sphinx-autoapi-3.3.3

Build fails with these:
pylint-3.3.2
sphinx-autoapi-3.4.0

If the situation does not fix itself, we should probably pin the working package versions to dev-requirements.txt.
@ptsavol ptsavol added the Docs label Dec 3, 2024
@ptsavol ptsavol self-assigned this Dec 3, 2024
ptsavol added a commit that referenced this issue Dec 16, 2024
@ptsavol
Build docs using python 3.12
f678984 
#3022
ptsavol added a commit that referenced this issue Dec 16, 2024
@ptsavol
Set a version limit for sphinx-autoapi in dev-requirements
07e554e 
Re #3022
ptsavol added a commit to spine-tools/Spine-Database-API that referenced this issue Dec 16, 2024
@ptsavol
Update building docs
b9b9c84 
- Build docs using python 3.12
- Reorder dev-requirements for consistency with toolbox dev-reqs

Re spine-tools/Spine-Toolbox#3022
ptsavol added a commit that referenced this issue Dec 16, 2024
@ptsavol
Minor edit to dev-reqs
46ac860 
Re #3022
@ptsavol
Copy link
Member Author

ptsavol commented Dec 16, 2024

Building the docs works again. Both toolbox and spinedb-api docs are now built using python 3.12, but I had to pin sphinx-autoapi version to <3.4 on toolbox side. On spinedb-api, the latest sphinx-autoapi works. I think the problem on toolbox side is related to some corrupted/missing docstring. Some related discussion on the topic can be found here.

@ptsavol ptsavol closed this as completed Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ptsavol ptsavol

Labels
Docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ptsavol