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

docs: pin dependency #272

Merged
merged 1 commit into from
Aug 27, 2023
Merged

docs: pin dependency #272

merged 1 commit into from
Aug 27, 2023

Conversation

Gaiejj
Copy link
Member

@Gaiejj Gaiejj commented Aug 27, 2023

Description

Pin the version of sphinx as 7.1.2.

Motivation and Context

Some issue exists in the 7.2.3 version of sphinx.
Read the docs would fail building the online documentation.
The error information is:

  File "/home/docs/checkouts/readthedocs.org/user_builds/omnisafe/envs/latest/lib/python3.9/site-packages/torch/__init__.py", line 1157, in <module>
    from torch._C._VariableFunctions import *  # type: ignore[misc] # noqa: F403
ModuleNotFoundError: No module named 'torch._C._VariableFunctions'; 'torch._C' is not a package

So this pull request pin the version of sphinx in 7.1.2 to solve it.

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds core functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

  • I have read the CONTRIBUTION guide. (required)
  • My change requires a change to the documentation.
  • I have updated the tests accordingly. (required for a bug fix or a new feature)
  • I have updated the documentation accordingly.
  • I have reformatted the code using make format. (required)
  • I have checked the code using make lint. (required)
  • I have ensured make test pass. (required)

@Gaiejj Gaiejj added bug Something isn't working documentation Improvements or additions to documentation dependency Something related to package dependencies labels Aug 27, 2023
@Gaiejj Gaiejj merged commit 368f84d into PKU-Alignment:main Aug 27, 2023
1 check passed
@Gaiejj Gaiejj deleted the dev-docs branch September 5, 2023 00:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working dependency Something related to package dependencies documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants