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.

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

Documentation: update packages? #1512

Open
sk1p opened this issue Sep 19, 2023 · 2 comments
Open

Documentation: update packages? #1512

sk1p opened this issue Sep 19, 2023 · 2 comments
Labels
dependencies Pull requests that update a dependency file docs infra Test/Build/Release infrastructure

Comments

@sk1p
Copy link
Member

sk1p commented Sep 19, 2023

It looks like our documentation dependencies in combination currently force installation of a quite old version of sphinx (5.x, current version is 7.x) , and also our theme used (sphinx-rtd-theme==0.5.1, current version 1.x).

(see logs for a recent docs build here, for example: https://github.com/LiberTEM/LiberTEM/actions/runs/6233324633/job/16918297835)

For now this is a combination that seems to work, but we need to keep an eye on this, and maybe at some point find out what is causing the issue, and get things up to date again.

A similar issue can be seen in LiberTEM-live, where the outdated sphinx-rtd-theme causes the build to fail if we don't additionally constrain the sphinx version to <7... LiberTEM/LiberTEM-live#131 - this should not be necessary, as the latest version of the theme does support the current sphinx version.

@sk1p sk1p added docs infra Test/Build/Release infrastructure dependencies Pull requests that update a dependency file labels Sep 19, 2023
@sk1p
Copy link
Member Author

sk1p commented May 16, 2024

sphinx is still constrained to <7.3, which is already better than the old constraint. I'll check in #1638 if we can remove that constraint, too.

@sk1p
Copy link
Member Author

sk1p commented May 16, 2024

Still fails with current sphinx, I'll revert:

/home/runner/work/LiberTEM/LiberTEM/docs/source/app/processing.rst:22: WARNING: domain for external cross-reference not found: 'ptychography40'
WARNING: cannot cache unpickable configuration value: 'nbsphinx_custom_formats' (because it contains a function, class, or module object)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file docs infra Test/Build/Release infrastructure
Projects
None yet
Development

No branches or pull requests

1 participant