Skip to content
This repository has been archived by the owner on Aug 30, 2022. It is now read-only.

Commit

Permalink
PB-116: pin docutils version (#259)
Browse files Browse the repository at this point in the history
Summary:

It seems that pip resolves the dependencies by profile. If the [doc]
profile is installed first, docutils ~= 0.16 is picked up, and when
xain-fl's install_requires is resolved, pip sees that docutils is
already installed but has an incompatible version.

I suspect the order in which pip handles the profiles depends on your
environment (pip version, platform, python version, etc.) which is why
we don't see this issue consistently.

As a workaround we explicitely depends on docutils in the [doc]
profile and restrict the version here.

References:

https://xainag.atlassian.net/browse/PB-116
  • Loading branch information
little-dude committed Feb 4, 2020
1 parent 731e71d commit 6e85165
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,13 @@
"m2r==0.2.1",
"sphinxcontrib-mermaid==0.3.1",
"sphinx-autodoc-typehints==1.10.3", # MIT
# docutils is a transitive dependency for docs_requires and
# install_requires, which are handled sequentially by pip. If the
# docs_requires dependencies are handled first, `docutils~=0.16`
# gets installed, whereas install_requires depends on
# `docutils<0.16`. To prevent this from happening, we just pin the
# docutils version here.
"docutils < 0.16",
]

setup(
Expand Down

0 comments on commit 6e85165

Please sign in to comment.