Page MenuHomeSoftware Heritage

tox: Add sphinx environments to check sane doc build
ClosedPublic

Authored by anlambert on Mon, Apr 26, 4:20 PM.

Details

Summary

Enable to check package documentation can be built without producing
sphinx warnings.

The sphinx environment is designed to be used in continuous integration
in order to prevent breaking documentation build when committing changes.

The sphinx-dev environment is designed to be used inside a full swh
development environment.

Related to T3258

Diff Detail

Repository
rDDEP Push deposit
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Build is green

Patch application report for D5596 (id=20005)

Rebasing onto 87b3b5e25f...

Current branch diff-target is up to date.
Changes applied before test
commit 8c73cb641fcb7c3de97d8871456d1b7e3fefa4d9
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 16:19:49 2021 +0200

    tox: Add sphinx environments to check sane doc build
    
    Enable to check package documentation can be built without producing
    sphinx warnings.
    
    The sphinx environment is designed to be used in continuous integration
    in order to prevent breaking documentation build when committing changes.
    
    The sphinx-dev environment is designed to be used inside a full swh
    development environment.
    
    Related to T3258

See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/641/ for more details.

This revision is now accepted and ready to land.Mon, Apr 26, 5:00 PM

Build has FAILED

Patch application report for D5596 (id=20005)

Rebasing onto 87b3b5e25f...

Current branch diff-target is up to date.
Changes applied before test
commit 8c73cb641fcb7c3de97d8871456d1b7e3fefa4d9
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 16:19:49 2021 +0200

    tox: Add sphinx environments to check sane doc build
    
    Enable to check package documentation can be built without producing
    sphinx warnings.
    
    The sphinx environment is designed to be used in continuous integration
    in order to prevent breaking documentation build when committing changes.
    
    The sphinx-dev environment is designed to be used inside a full swh
    development environment.
    
    Related to T3258

Link to build: https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/642/
See console output for more information: https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/642/console

Build has FAILED

Patch application report for D5596 (id=20005)

Rebasing onto 87b3b5e25f...

Current branch diff-target is up to date.
Changes applied before test
commit 8c73cb641fcb7c3de97d8871456d1b7e3fefa4d9
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 16:19:49 2021 +0200

    tox: Add sphinx environments to check sane doc build
    
    Enable to check package documentation can be built without producing
    sphinx warnings.
    
    The sphinx environment is designed to be used in continuous integration
    in order to prevent breaking documentation build when committing changes.
    
    The sphinx-dev environment is designed to be used inside a full swh
    development environment.
    
    Related to T3258

Link to build: https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/643/
See console output for more information: https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/643/console

Update: Ensure to build/clean svg images included in documentation

Build is green

Patch application report for D5596 (id=20051)

Rebasing onto 87b3b5e25f...

Current branch diff-target is up to date.
Changes applied before test
commit d0f3d3d3bd769813a09e93a05cfe4b328fa366e5
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 16:19:49 2021 +0200

    tox: Add sphinx environments to check sane doc build
    
    Enable to check package documentation can be built without producing
    sphinx warnings.
    
    The sphinx environment is designed to be used in continuous integration
    in order to prevent breaking documentation build when committing changes.
    
    The sphinx-dev environment is designed to be used inside a full swh
    development environment.
    
    Related to T3258

commit cae4a3c4918cbc2c2049534e918777de4f7e7ed1
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Tue Apr 27 14:17:08 2021 +0200

    docs/Makefile: Ensure to build/clean included svg images

See https://jenkins.softwareheritage.org/job/DDEP/job/tests-on-diff/644/ for more details.