Staging instance, all changes can be removed at any time

Skip to content

Use Sphinx 2.x to build the documentation

Development documentation fails to build since a couple of days due to the following error:

Exception occurred:
  File "/home/jenkins/workspace/DDOC/dev/swh-docs/.tox/sphinx-dev/lib/python3.7/site-packages/pkg_resources/__init__.py", line 792, in resolve
    raise VersionConflict(dist, req).with_context(dependent_req)
pkg_resources.VersionConflict: (Sphinx 1.8.5 (/home/jenkins/workspace/DDOC/dev/swh-docs/.tox/sphinx-dev/lib/python3.7/site-packages), Requirement.parse('sphinx>=2.0; python_version >= "3.0"'))

Using Sphinx 2.x to build the documentation should fix that issue. We were still using Sphinx < 2 to build the doc due to the sphinxcontrib-images extension not being compatible with latest Sphinx releases. The good news is that the fresh 0.9.1 release of that extension adds Sphinx 2.x support.

We should now be able to build the development documentation with latest Sphinx release. Some new warnings should appear with that upgrade and must also be fixed to get the associated Jenkins job green again.

Migrated from T2264 (view on Phabricator)