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

Specify Sphinx version >=1.8,<2 in dev dependencies #494

Merged
merged 1 commit into from
Jul 3, 2022

Conversation

hakonanes
Copy link
Contributor

@hakonanes hakonanes commented Jun 28, 2022

Signed-off-by: Håkon Wiik Ånes [email protected]

Description

Docs aren't built successfully by Read The Docs because Sphinx is pinned to v1.7.6 in requirements-dev.txt, but #468 introduced a doc change which requires Sphinx v1.8 or newer. This PR updates the Sphinx version to >=1.8,<2 in requirements-dev.txt so that the docs can hopefully be built successfully.

Related Issue

No open issues address that the docs fail, but this issue e.g. #389 cannot go on unless this is fixed.

Motivation and Context

We depend on PySwarms in PyEBSDIndex (https://github.com/USNavalResearchLaboratory/PyEBSDIndex) and would like for our dependencies to have an up-to-date documentation for our users to read.

How Has This Been Tested?

On Ubuntu 22.04.

Not tested, since I tried building the docs myself but got this error:

$ conda create -n ps-env python=3.9
$ conda activate ps-env
$ python setup.py develop
$ pip install 'sphinx>=1.8,<2'
$ cd docs
$ make html
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v1.8.6

Extension error:
Could not import extension sphinx.builders.latex (exception: cannot import name 'contextfunction' from 'jinja2' (/home/hakon/miniconda3/envs/ps-env/lib/python3.9/site-packages/jinja2/__init__.py))
make: *** [Makefile:53: html] Error 2

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

Checklist:

  • [n/a] My code follows the code style of this project.
  • [n/a] My change requires a change to the documentation.
  • [n/a] I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • [n/a] I have added tests to cover my changes.
  • All new and existing tests passed.

@ljvmiranda921 ljvmiranda921 self-assigned this Jun 29, 2022
@ljvmiranda921
Copy link
Owner

ljvmiranda921 commented Jun 29, 2022

I might be able to review this PR this weekend (July 2)

@ljvmiranda921 ljvmiranda921 merged commit 1c57bf5 into ljvmiranda921:master 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.

2 participants