Skip to content
This repository has been archived by the owner on Jan 8, 2025. It is now read-only.

Commit

Permalink
Work around pip resolver gotcha with latest Sphinx. Bump version to 3…
Browse files Browse the repository at this point in the history
….1.2. Fix #172.
  • Loading branch information
erikrose committed Apr 15, 2021
1 parent 606ac8c commit 91d35b8
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
5 changes: 4 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ A good example using most of sphinx-js's functionality is the Fathom documentati

Then put the version of sphinx-js you want in ``docs/requirements.txt``. For example... ::

sphinx-js==3.1.1
sphinx-js==3.1.2

Or, if you prefer, the Fathom repo carries a `Travis CI configuration <https://github.com/mozilla/fathom/blob/92304b8ad4768e90c167c3d93f9865771f5a6d80/.travis.yml#L41>`_ and a `deployment script <https://github.com/mozilla/fathom/blob/92304b8ad4768e90c167c3d93f9865771f5a6d80/tooling/travis-deploy-docs>`_ for building docs with sphinx-js and publishing them to GitHub Pages. Feel free to borrow them.

Expand All @@ -348,6 +348,9 @@ Run the tests using tox, which will also install JSDoc and TypeDoc at pinned ver
Version History
===============

3.1.2
* Remove our declared dependency on ``docutils`` to work around the way pip's greedy dependency resolver reacts to the latest version of Sphinx. pip fails when pip-installing sphinx-js because pip sees our "any version of docutils" declaration first (which resolves greedily to the latest version, 0.17) but later encounters Sphinx's apparently new ``<0.17`` constraint and gives up. We can revert this when pip's ``--use-feature=2020-resolver`` becomes the default.

3.1.1
* Rewrite large parts of the suffix tree that powers path lookup. This fixes several crashers.

Expand Down
6 changes: 3 additions & 3 deletions requirements_dev.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
pytest==5.4.3
recommonmark==0.6.0
pytest==6.2.3
recommonmark==0.7.1
# Sphinx's plain-text renderer changes behavior slightly
# with regard to how it emits class names and em dashes from
# time to time:
Sphinx==3.1.1
Sphinx==3.5.4
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

setup(
name='sphinx-js',
version='3.1.1',
version='3.1.2',
description='Support for using Sphinx on JSDoc-documented JS code',
long_description=open('README.rst', 'r', encoding='utf8').read(),
long_description_content_type="text/x-rst",
Expand All @@ -14,7 +14,7 @@
packages=find_packages(exclude=['ez_setup']),
url='https://github.com/mozilla/sphinx-js',
include_package_data=True,
install_requires=['docutils', 'Jinja2>2.0,<3.0', 'parsimonious>=0.7.0,<0.8.0', 'Sphinx>=3.0.0'],
install_requires=['Jinja2>2.0,<3.0', 'parsimonious>=0.7.0,<0.8.0', 'Sphinx>=3.0.0'],
python_requires='>=3.7',
classifiers=[
'Intended Audience :: Developers',
Expand Down

0 comments on commit 91d35b8

Please sign in to comment.