[tahoe-lafs-trac-stream] [Tahoe-LAFS] #3665: Remove docutils pin from tox configuration

[Tahoe-LAFS]

#3665: Remove docutils pin from tox configuration
------------------------------------+-----------------------
     Reporter:  sajith              |      Owner:  sajith
         Type:  defect              |     Status:  new
     Priority:  normal              |  Milestone:  undecided
    Component:  dev-infrastructure  |    Version:  n/a
   Resolution:                      |   Keywords:
Launchpad Bug:                      |
------------------------------------+-----------------------

Comment (by sajith):

 Originally the pin was at docutils==0.12 (2014 July vintage), because of a
 specific bug about the handling SVG files.  Sphinx fixed that bug in 2016
 December, and docutils is a dependency only via Sphinx, so the comment
 about having to pin docutils because of that bug is no longer valid.

 I don't think it was the pinned dependency that made `tox -e docs` work.
 My guess is that CI failure was something transient, because it went away
 when I re-ran the job.  This was the error:

 {{{
 #!/bin/bash -eo pipefail
 /tmp/venv/bin/tox -e docs

 docs create: /root/project/.tox/docs
 docs installdeps: sphinx, recommonmark, sphinx_rtd_theme
 docs installed:
 alabaster==0.7.12,Babel==2.9.0,certifi==2020.12.5,chardet==4.0.0,commonmark==0.9.1,docutils==0.17,idna==2.10,imagesize==1.2.0,Jinja2==2.11.3,MarkupSafe==1.1.1,packaging==20.9,Pygments==2.8.1,pyparsing==2.4.7,pytz==2021.1,recommonmark==0.7.1,requests==2.25.1,snowballstemmer==2.1.0,Sphinx==3.5.3
 ,sphinx-rtd-theme==0.5.1,sphinxcontrib-applehelp==1.0.2,sphinxcontrib-
 devhelp==1.0.2,sphinxcontrib-htmlhelp==1.0.3,sphinxcontrib-jsmath==1.0.1
 ,sphinxcontrib-qthelp==1.0.3,sphinxcontrib-
 serializinghtml==1.1.4,urllib3==1.26.4
 docs run-test-pre: PYTHONHASHSEED='1530122825'
 docs run-test: commands[0] | sphinx-build -b html -d
 /root/project/docs/_build/doctrees /root/project/docs
 /root/project/docs/_build/html
 Running Sphinx v3.5.3

 Encoding error:
 'ascii' codec can't decode byte 0xc2 in position 69: ordinal not in
 range(128)
 The full traceback has been saved in /tmp/sphinx-err-yf65zi0c.log, if you
 want to report the issue to the developers.
 ERROR: InvocationError for command /root/project/.tox/docs/bin/sphinx-
 build -b html -d /root/project/docs/_build/doctrees docs
 /root/project/docs/_build/html (exited with code 2)
 ___________________________________ summary
 ____________________________________
 ERROR:   docs: commands failed

 Exited with code exit status 1
 }}}

 It does not fail for me locally, and I could not reproduce it on CI for a
 third or fourth time either.  I tried it with two recent versions of
 docutils (0.16 released on 2020-01-12, 0.17 released on 2021-04-03), both
 locally and on CI.

--
Ticket URL: <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/3665#comment:4>
Tahoe-LAFS <https://Tahoe-LAFS.org>
secure decentralized storage