Skip to contentSkip to conversation

Force Travis-CI to use sphinx 1.5.6

PATCH In review Grant Likely 2 participants 3 messages Dec 7, 2017 2 messages not in the archive

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Force Travis-CI to use sphinx 1.5.6

Sphinx versions 1.6.1 and later have switched to using the mklatex script which seems to interact badly with the graphviz output and the graphics end up being too wide. Until a fix can be found, force Travis CI to use the older release of Sphinx.

---

Rob, can you try this out and see if it solves the image size problem on Travis CI?

Thanks,
g.

 .travis.yml |  2 +-
 README.md   | 12 ++++++++----
 2 files changed, 9 insertions(+), 5 deletions(-)
.travis.yml +1 -1
index 3be8381..e9538d4 100644
@@ -23,7 +23,7 @@ addons:
 
 install:
   - pip install --user mako
-  - pip install --user Sphinx
+  - pip install --user Sphinx==1.5.6
 
 script:
   - make latexpdf
README.md +8 -4
index 55717b4..6fcb16f 100644
@@ -12,10 +12,14 @@ This [repository](https://github.com/devicetree-org/devicetree-specification) ho
 
 Requirements:
 * Sphinx: http://sphinx-doc.org/contents.html
- * version 1.2.3 or later
+ * version 1.2.3 or later, but no later than version 1.5.6
 * LaTeX (and pdflatex, and various LaTeX packages)
 * Graphviz (in particular, "dot"): http://www.graphviz.org/
 
+There is a problem with image layout on Sphinx version 1.6.1 and later that
+causes images to be too wide.
+The problem is being investigated, but in the mean time use the older release.
+
 On Debian and Ubuntu:
 
 >```
@@ -29,7 +33,7 @@ On Debian and Ubuntu:
 >
 >```
 >$ apt-get install python-pip
->$ pip install --user --upgrade Sphinx
+>$ pip install --user --upgrade Sphinx==1.5.6
 >$ export SPHINXBUILD=~/.local/bin/sphinx-build
 >```
 >
@@ -45,9 +49,9 @@ On Mac OS X:
 >```
 >Install Sphinx
 >```
->pip install --user --upgrade Sphinx
+>pip install --user --upgrade Sphinx==1.5.6
 >Or
->sudo pip install --upgrade Sphinx
+>sudo pip install --upgrade Sphinx==1.5.6
 >```
 >
 >If you are using [brew](http://brew.sh) then you can install graphviz like this:
Signature · 1 line
2.11.0

A message that is not in the archive (sent off-list or not yet received): [email protected]

#2 lore raw
Quoted 10 lines · Grant Likely

Sphinx versions 1.6.1 and later have switched to using the mklatex script which seems to interact badly with the graphviz output and the graphics end up being too wide. Until a fix can be found, force Travis CI to use the older release of Sphinx.

---

Rob, can you try this out and see if it solves the image size problem on Travis CI?

Oh, wait. You've already fixed this in the main tree. I only just did a git update. Sorry for the noise.

g.

Quoted 65 lines

Thanks,
g.

 .travis.yml |  2 +-
 README.md   | 12 ++++++++----
 2 files changed, 9 insertions(+), 5 deletions(-)
.travis.yml +1 -1
index 3be8381..e9538d4 100644
@@ -23,7 +23,7 @@ addons:
 
 install:
   - pip install --user mako
-  - pip install --user Sphinx
+  - pip install --user Sphinx==1.5.6
 
 script:
   - make latexpdf
README.md +8 -5
index 55717b4..6fcb16f 100644
@@ -12,10 +12,14 @@ This [repository](https://github.com/devicetree-org/devicetree-specification) ho
 
 Requirements:
 * Sphinx: http://sphinx-doc.org/contents.html
- * version 1.2.3 or later
+ * version 1.2.3 or later, but no later than version 1.5.6
 * LaTeX (and pdflatex, and various LaTeX packages)
 * Graphviz (in particular, "dot"): http://www.graphviz.org/
 
+There is a problem with image layout on Sphinx version 1.6.1 and later that
+causes images to be too wide.
+The problem is being investigated, but in the mean time use the older release.
+
 On Debian and Ubuntu:
 
 >```
@@ -29,7 +33,7 @@ On Debian and Ubuntu:
 >
 >```
 >$ apt-get install python-pip
->$ pip install --user --upgrade Sphinx
+>$ pip install --user --upgrade Sphinx==1.5.6
 >$ export SPHINXBUILD=~/.local/bin/sphinx-build
 >```
 >
@@ -45,9 +49,9 @@ On Mac OS X:
 >```
 >Install Sphinx
 >```
->pip install --user --upgrade Sphinx
+>pip install --user --upgrade Sphinx==1.5.6
 >Or
->sudo pip install --upgrade Sphinx
+>sudo pip install --upgrade Sphinx==1.5.6
 >```
 >
 >If you are using [brew](http://brew.sh) then you can install graphviz like this:
--

2.11.0

A message that is not in the archive (sent off-list or not yet received): CACxGe6vu68M9eiJLDH+9=1hy+qvcBM=+G_eiHJXpXvwXXC5=Gg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org

#4 lore raw
Quoted 6 lines · Grant Likely
Quoted 5 lines · Grant Likely

Sphinx versions 1.6.1 and later have switched to using the mklatex script which seems to interact badly with the graphviz output and the graphics end up being too wide. Until a fix can be found, force Travis CI to use the older release of Sphinx.

Quoted 8 lines
Quoted 5 lines

---

Rob, can you try this out and see if it solves the image size problem on Travis CI?

Oh, wait. You've already fixed this in the main tree. I only just did a git update. Sorry for the noise.

Next time it breaks, I'm just going to fix the version. :)

Rob