Page MenuHomeSoftware Heritage

building docs with tox fails
Closed, ResolvedPublic

Description

trying to build the documentation as documented in the README fails for me with the following traceback:

$ tox -e sphinx-dev
GLOB sdist-make: /home/zack/dati/projects/sw-heritage/git/swh-environment/swh-docs/setup.py
sphinx-dev inst-nodeps: /home/zack/dati/projects/sw-heritage/git/swh-environment/swh-docs/.tox/dist/swh.docs-0.0.0.post120.zip
sphinx-dev installed: aiohttp==3.5.0,alabaster==0.7.12,amqp==2.3.2,apache-libcloud==2.4.0,arrow==0.12.1,asn1crypto==0.24.0,async-timeout==3.0.1,atomicwrites==1.2.1,attrs==18.2.0,azure-common==1.1.16,azure-nspkg==3.0.2,azure-storage==0.36.0,Babel==2.6.0,beautifulsoup4==4.6.3,billiard==3.5.0.5,celery==4.2.1,certifi==2018.11.29,cffi==1.11.5,chardet==3.0.4,Click==7.0,CommonMark==0.5.4,cryptography==2.4.2,daiquiri==1.5.0,Django==1.11.17,django-js-reverse==0.8.2,django-webpack-loader==0.6.0,djangorestframework==3.9.0,docutils==0.14,dulwich==0.19.9,elasticsearch==6.3.1,extras==1.0.0,fastimport==0.9.8,file-magic==0.4.0,fixtures==3.0.0,Flask==1.0.2,htmlmin==0.1.12,idna==2.8,imagesize==1.1.0,itsdangerous==1.1.0,Jinja2==2.10,kafka-python==1.4.4,kombu==4.2.2,linecache2==1.0.0,lxml==4.2.5,MarkupSafe==1.1.0,more-itertools==4.3.0,msgpack-python==0.5.6,multidict==4.5.2,packaging==18.0,patool==1.12,pbr==5.1.1,pifpaf==2.2.1,pkg-resources==0.0.0,pkginfo==1.4.2,pluggy==0.8.0,psutil==5.4.8,psycopg2==2.7.6.1,py==1.7.0,pycparser==2.19,Pygments==2.3.1,PyLD==1.0.4,pypandoc==1.4,pyparsing==2.3.0,pytest==4.0.2,python-cephlibs==0.94.5.post1,python-dateutil==2.7.5,python-debian==0.1.33,python-hglib==2.6.1,python-mimeparse==1.6.0,pytz==2018.7,PyYAML==3.13,recommonmark==0.4.0,requests==2.21.0,retrying==1.3.3,six==1.12.0,snowballstemmer==1.2.1,Sphinx==1.8.2,sphinxcontrib-httpdomain==1.7.0,sphinxcontrib-images==0.8.0,sphinxcontrib-websupport==1.1.0,SQLAlchemy==1.2.15,sqlitedict==1.6.0,subvertpy==0.10.1,swh.archiver==0.0.5.post1,swh.core==0.0.49,swh.deposit==0.0.64.post2,swh.docs==0.0.0.post120,swh.indexer==0.0.121.post2,swh.journal==0.0.6,swh.lister==0.0.18.post16,swh.loader.core==0.0.38,swh.loader.debian==0.0.12,swh.loader.dir==0.0.33,swh.loader.git==0.0.47,swh.loader.mercurial==0.0.15,swh.loader.pypi==0.0.8,swh.loader.svn==0.0.43,swh.loader.tar==0.0.37.post1,swh.mirror.forge==0.0.5.post17,swh.model==0.0.29.post3,swh.objstorage==0.0.28,swh.scheduler==0.0.38,swh.storage==0.0.117,swh.vault==0.0.20.post26,swh.web==0.0.172.post1,systemd-python==234,testtools==2.3.0,traceback2==1.4.0,unittest2==1.1.0,urllib3==1.24.1,vcversioner==2.16.0.0,vine==1.1.4,Werkzeug==0.14.1,xattr==0.9.6,xmltodict==0.11.0,yarl==1.3.0
sphinx-dev runtests: PYTHONHASHSEED='2509556986'
sphinx-dev runtests: commands[0] | /home/zack/dati/projects/sw-heritage/git/swh-environment/swh-docs/.tox/sphinx-dev/bin/python -m pifpaf run postgresql -- make -C docs html
make: Entering directory '/home/zack/dati/projects/sw-heritage/git/swh-environment/swh-docs/docs'
make -C ../../ docs-assets
make[1]: Entering directory '/home/zack/dati/projects/sw-heritage/git/swh-environment'
make -C swh-archiver/docs assets
make[2]: Entering directory '/home/zack/dati/projects/sw-heritage/git/swh-environment/swh-archiver/docs'
make[2]: Nothing to be done for 'assets'.
make[2]: Leaving directory '/home/zack/dati/projects/sw-heritage/git/swh-environment/swh-archiver/docs'
make -C swh-core/docs assets
make[2]: Entering directory '/home/zack/dati/projects/sw-heritage/git/swh-environment/swh-core/docs'
make[2]: Nothing to be done for 'assets'.
make[2]: Leaving directory '/home/zack/dati/projects/sw-heritage/git/swh-environment/swh-core/docs'
make -C swh-deposit/docs assets
make[2]: Entering directory '/home/zack/dati/projects/sw-heritage/git/swh-environment/swh-deposit/docs'
make[2]: Nothing to be done for 'assets'.
make[2]: Leaving directory '/home/zack/dati/projects/sw-heritage/git/swh-environment/swh-deposit/docs'
make -C swh-docker-dev/docs assets
make[2]: Entering directory '/home/zack/dati/projects/sw-heritage/git/swh-environment'
make[2]: *** swh-docker-dev/docs: No such file or directory.  Stop.
make[2]: Leaving directory '/home/zack/dati/projects/sw-heritage/git/swh-environment'
make[1]: *** [Makefile:32: docs-assets/swh-docker-dev] Error 2
make[1]: Leaving directory '/home/zack/dati/projects/sw-heritage/git/swh-environment'
make: *** [Makefile:43: rec-build-stamp] Error 2
make: Leaving directory '/home/zack/dati/projects/sw-heritage/git/swh-environment/swh-docs/docs'
WARNING [pifpaf.drivers] `psutil.Popen(pid=5983, status='terminated')` is already gone, sending SIGKILL to its process group
WARNING [pifpaf.drivers] `psutil.Popen(pid=5963, status='terminated')` is already gone, sending SIGKILL to its process group
WARNING [pifpaf.drivers] `psutil.Popen(pid=5958, status='terminated')` is already gone, sending SIGKILL to its process group
ERROR: InvocationError: '/home/zack/dati/projects/sw-heritage/git/swh-environment/swh-docs/.tox/sphinx-dev/bin/python -m pifpaf run postgresql -- make -C docs html'
___________________________________________________________________________________________ summary ___________________________________________________________________________________________
ERROR:   sphinx-dev: commands failed

Details

Differential Revisions
D881: Fix build of swh-docs.

Event Timeline

zack triaged this task as High priority.Dec 25 2018, 8:56 PM
zack created this task.
zack added a comment.Dec 27 2018, 5:28 PM

after D881, tox -e sphinx-dev now fails with a different error:

Exception occurred:
  File "/home/zack/dati/projects/sw-heritage/git/swh-environment/swh-docs/.tox/sphinx-dev/lib/python3.7/site-packages/sphinxcontrib/images.py", line 214, in is_remote
    .format(uri))
ValueError: Image URI `images/tasks-lister.svg` have to be local relative or absolute path to image, or remote address.
The full traceback has been saved in /tmp/sphinx-err-dv4lb4gw.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
make: *** [Makefile:61: sphinx/html] Error 2
make: Leaving directory '/home/zack/dati/projects/sw-heritage/git/swh-environment/swh-docs/docs'
WARNING [pifpaf.drivers] `psutil.Popen(pid=5714, status='terminated')` is already gone, sending SIGKILL to its process group
WARNING [pifpaf.drivers] `psutil.Popen(pid=5697, status='terminated')` is already gone, sending SIGKILL to its process group
WARNING [pifpaf.drivers] `psutil.Popen(pid=5692, status='terminated')` is already gone, sending SIGKILL to its process group
ERROR: InvocationError: '/home/zack/dati/projects/sw-heritage/git/swh-environment/swh-docs/.tox/sphinx-dev/bin/python -m pifpaf run postgresql -- make -C docs html'
___________________________________________ summary ___________________________________________
ERROR:   sphinx-dev: commands failed

the file in question (tasks-lister.svg) is properly generated by running make by hand, but it is not when the build is done by tox

zack closed this task as Resolved.Jan 8 2019, 11:53 AM
zack claimed this task.