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

ci: refresh docs build dependencies #1708

Merged
merged 5 commits into from
Aug 20, 2024
Merged

ci: refresh docs build dependencies #1708

merged 5 commits into from
Aug 20, 2024

Conversation

ansible-documentation-bot[bot]
Copy link
Contributor

No description provided.

@ansible-documentation-bot ansible-documentation-bot bot added doc builds Relates to building the documentation no_backport This PR should not be backported. devel only. dependency_update PR to update pinned dependencies labels Jul 21, 2024
@samccann
Copy link
Contributor

@oraNod
Copy link
Contributor

oraNod commented Jul 23, 2024

@oraNod @gotmax23 - anyone know why rstcheck is dropped down multiple versions in this PR - https://github.com/ansible/ansible-documentation/pull/1708/files#diff-f3e33d99f9b9fef050ee5b226fa3aedb48919f53d607a445970e11ffb0bf66ffR108

nice catch @samccann I'm not sure why rstcheck was dropped down. initially I was thinking maybe it was related to one of the other dependencies, perhaps sphinx. but I don't think that's the case. I know rstcheck has an upper bound:

rstcheck < 6 # rstcheck 6.x has problem with rstcheck.core triggered by include files w/ sphinx directives https://github.com/rstcheck/rstcheck-core/issues/3
but this doesn't explain why the version would drop. afaik this PR is produced with the equivalent of pip-compile --upgrade <requirements>

@oraNod
Copy link
Contributor

oraNod commented Aug 20, 2024

@samccann Hey, I guess this one slipped through the cracks a little. I took another look and it seems there is an incompatibility with a docutils for rstcheck 5.0.0 and sphinx 7.4.7.

I set up a test venv:

$ rstcheck --version
rstcheck 5.0.0

$ python -m pip install --upgrade sphinx==7.4.7

...

ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
rstcheck 5.0.0 requires docutils<0.19,>=0.7, but you have docutils 0.21.2 which is incompatible.
Successfully installed Jinja2-3.1.4 MarkupSafe-2.1.5 alabaster-0.7.16 babel-2.16.0 certifi-2024.7.4 charset-normalizer-3.3.2 docutils-0.21.2 imagesize-1.4.1 requests-2.32.3 snowballstemmer-2.2.0 sphinx-7.4.7 sphinxcontrib-applehelp-2.0.0 sphinxcontrib-devhelp-2.0.0 sphinxcontrib-htmlhelp-2.1.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-2.0.0 sphinxcontrib-serializinghtml-2.0.0 urllib3-2.2.2

$ docutils --version
docutils (Docutils 0.21.2, Python 3.12.4, on linux)

$ sphinx-build --version
sphinx-build 7.4.7

Copy link
Contributor

@oraNod oraNod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. The rstcheck version change is in requirements-relaxed.txt which is used for dev / experimental builds so shouldn't be a problem.

@oraNod oraNod merged commit b56cea3 into devel Aug 20, 2024
9 checks passed
@oraNod oraNod deleted the pip-compile/devel/docs branch August 20, 2024 10:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependency_update PR to update pinned dependencies doc builds Relates to building the documentation no_backport This PR should not be backported. devel only.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants