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

[Doc] Fix doc generation: pin dependencies versions #1347

Merged
merged 4 commits into from Jan 16, 2024

Conversation

dmitriy-sobolev
Copy link
Contributor

@dmitriy-sobolev dmitriy-sobolev commented Jan 15, 2024

Many tools prefixed with sphinxcontrib_, for example sphinxcontrib_applehelp, recently updated their versions. They are not compatible with sphinx versions older than 5, while we use 3. It looks like these tools are installed as docutils dependencies.

See sphinx-doc/sphinxcontrib-applehelp#15 (comment) for more details.

Signed-off-by: Dmitriy Sobolev <dmitriy.sobolev@intel.com>
@dmitriy-sobolev dmitriy-sobolev changed the title [Doc] Fix doc generation: pin sphinxcontrib_applehelp version [Doc] Fix doc generation: pin dependencies version Jan 15, 2024
@dmitriy-sobolev
Copy link
Contributor Author

@ValentinaKats, This PR can be merged as a short-term or mid-term fix.
I am also going to try another approach separately: updating Sphinx to avoid such issues in the future. It may take more time to investigate given many other pinned dependencies.

@dmitriy-sobolev dmitriy-sobolev marked this pull request as ready for review January 15, 2024 21:45
@dmitriy-sobolev dmitriy-sobolev changed the title [Doc] Fix doc generation: pin dependencies version [Doc] Fix doc generation: pin dependencies versions Jan 15, 2024
Copy link
Contributor

@ValentinaKats ValentinaKats left a comment

Choose a reason for hiding this comment

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

LGTM

@dmitriy-sobolev dmitriy-sobolev merged commit d38cf73 into main Jan 16, 2024
20 checks passed
@dmitriy-sobolev dmitriy-sobolev deleted the dev/dmitriy-sobolev/fix-doc-gen branch January 16, 2024 12:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants