Page MenuHomeSoftware Heritage

Fix documentation build on Jenkins
Closed, ResolvedPublic

Description

The development documentation fails to build since a while on Jenkins and thus do not get uploaded on https://docs.softwareheritage.org/devel/ which is now quite outdated.

The following errors and warnings have to be fixed to unlock the situation. Let's track that work here.

Event Timeline

anlambert triaged this task as Normal priority.Jan 17 2020, 2:10 PM
anlambert created this task.

Almost there ! All swh modules have been processed. The remaining warnings to fix are the following:

WARNING: autodoc: failed to import module 'dataset' from module 'swh'; the following exception was raised:
No module named 'swh.dataset'
/home/antoine/swh/swh-environment/swh-docs/docs/index.rst:121: WARNING: toctree contains reference to nonexisting document 'manual-setup'
/home/antoine/swh/swh-environment/swh-docs/docs/index.rst:121: WARNING: toctree contains reference to nonexisting document 'swh-loader'
/home/antoine/swh/swh-environment/swh-docs/docs/swh-dataset/graph/dataset.rst:2: WARNING: Duplicate explicit target name: "/graph/latest/popular-3k-python/sql/".
/home/antoine/swh/swh-environment/swh-docs/docs/swh-dataset/graph/schema.rst:20: WARNING: Bullet list ends without a blank line; unexpected unindent.
/home/antoine/swh/swh-environment/swh-docs/docs/swh-search/index.rst:4: WARNING: duplicate label swh-py-template, other instance in /home/antoine/swh/swh-environment/swh-docs/docs/swh-icinga-plugins/index.rst
/home/antoine/swh/swh-environment/swh-docs/docs/swh-icinga-plugins/index.rst: WARNING: document isn't included in any toctree
/home/antoine/swh/swh-environment/swh-docs/docs/swh-loader-core/index.rst: WARNING: document isn't included in any toctree
/home/antoine/swh/swh-environment/swh-docs/docs/swh-loader-git/index.rst: WARNING: document isn't included in any toctree
/home/antoine/swh/swh-environment/swh-docs/docs/swh-loader-mercurial/index.rst: WARNING: document isn't included in any toctree
/home/antoine/swh/swh-environment/swh-docs/docs/swh-loader-svn/index.rst: WARNING: document isn't included in any toctree
/home/antoine/swh/swh-environment/swh-docs/docs/swh-search/index.rst: WARNING: document isn't included in any toctree
/home/antoine/swh/swh-environment/swh-docs/docs/infrastructure/storage_site_rocquencourt_physical.rst:7: WARNING: undefined label: ceph cluster (if the link has no caption the label must precede a section header)
WARNING: logo file 'software-heritage-logo-title-motto-vertical-white.png' does not exist
anlambert closed this task as Resolved.Mon, Jan 20, 2:59 PM
anlambert claimed this task.

Closing this as development documentation now builds without errors (see https://jenkins.softwareheritage.org/view/all/job/DDOC/job/dev/).

Awesome!
Thanks.