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

pin sphinx version becuase of sphinx bug in 3.2.0 #238

Merged
merged 2 commits into from Aug 12, 2020

Conversation

jandremarais
Copy link
Contributor

Description

Because of this bug, sphinx-doc/sphinx#8074, we can't use sphinx 3.2.0 to build docs for latest PyDP with docstrings. It results in

Extension error:
Handler <function _process_docstring at 0x7f5a23643310> for event 'autodoc-process-docstring' threw an exception (exception: module, class, method, function, traceback, frame, or code object was expected, got instancemethod)
Makefile:56: recipe for target 'html' failed
make: *** [html] Error 2

To reproduce - inside PyDP (dev branch) and in a clean virtual environment, run:

pip install .
pip install sphinx-rtd-theme
cd docs
make html

Thus without restricting the version of Sphinx, in docs/requirements.txt we run the risk of install 3.2.0 and therefore building the docs will fail. Thus the fix in this PR restricts the version of Sphinx in docs/requirements.txt to be no greater than 3.1.2.

Affected Dependencies

Sphinx

How has this been tested?

In a new python environment with only the python-dp in the current dev branch installed, running:

cd docs
pip install -r requirements.txt
make html

succesfully builds the docs.

Checklist

Copy link
Member

@chinmayshah99 chinmayshah99 left a comment

Choose a reason for hiding this comment

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

Nice catch!

@chinmayshah99 chinmayshah99 merged commit 83982ab into OpenMined:dev Aug 12, 2020
dvadym pushed a commit to dvadym/PyDP that referenced this pull request Jul 3, 2022
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