Page MenuHomeSoftware Heritage

tox: Add sphinx environments to check sane doc build
ClosedPublic

Authored by anlambert on Mon, Apr 26, 6:09 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
rDSTO Storage manager
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Build was aborted

Patch application report for D5613 (id=20023)

Rebasing onto 2c477ec442...

First, rewinding head to replay your work on top of it...
Applying: tox: Add sphinx environments to check sane doc build
Changes applied before test
commit 671d46133dfd1ceeed7835b877956481b99986da
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 18:09:05 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/DSTO/job/tests-on-diff/1272/
See console output for more information: https://jenkins.softwareheritage.org/job/DSTO/job/tests-on-diff/1272/console

Harbormaster returned this revision to the author for changes because remote builds failed.Mon, Apr 26, 6:30 PM
Harbormaster failed remote builds in B21021: Diff 20023!

Build has FAILED

Patch application report for D5613 (id=20023)

Rebasing onto 2c477ec442...

First, rewinding head to replay your work on top of it...
Applying: tox: Add sphinx environments to check sane doc build
Changes applied before test
commit 4cabcbe8665b95160ada5dd6e76063b82aef7993
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 18:09:05 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/DSTO/job/tests-on-diff/1273/
See console output for more information: https://jenkins.softwareheritage.org/job/DSTO/job/tests-on-diff/1273/console

Use pifpaf for sql-autodoc to work.

Build is green

Patch application report for D5613 (id=20040)

Rebasing onto 2c477ec442...

First, rewinding head to replay your work on top of it...
Applying: tox: Add sphinx environments to check sane doc build
Changes applied before test
commit 8a46aed0d5be9b59b97b75a5a0a0df85e05b4766
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 18:09:05 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/DSTO/job/tests-on-diff/1274/ for more details.

This revision is now accepted and ready to land.Tue, Apr 27, 12:56 PM

Build is green

Patch application report for D5613 (id=20041)

Rebasing onto 2c477ec442...

Current branch diff-target is up to date.
Changes applied before test
commit 615d719cfce70443142aadc6e1d4b090fe887a3b
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 18:09:05 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/DSTO/job/tests-on-diff/1275/ for more details.