Page MenuHomeSoftware Heritage

tox: Add sphinx environments to check sane doc build
ClosedPublic

Authored by anlambert on Tue, Apr 27, 2:54 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
rDWCLI Web client
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Build has FAILED

Patch application report for D5621 (id=20057)

Rebasing onto 7c8433cb92...

Current branch diff-target is up to date.
Changes applied before test
commit 4b610adf449de30637ab9c31591447a6655156bc
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Tue Apr 27 14:54:17 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/DWCLI/job/tests-on-diff/46/
See console output for more information: https://jenkins.softwareheritage.org/job/DWCLI/job/tests-on-diff/46/console

Harbormaster returned this revision to the author for changes because remote builds failed.Tue, Apr 27, 2:56 PM
Harbormaster failed remote builds in B21051: Diff 20057!

Build is green

Patch application report for D5621 (id=20057)

Rebasing onto 7c8433cb92...

Current branch diff-target is up to date.
Changes applied before test
commit 4b610adf449de30637ab9c31591447a6655156bc
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Tue Apr 27 14:54:17 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/DWCLI/job/tests-on-diff/47/ for more details.

This revision was not accepted when it landed; it landed in state Needs Review.Wed, Apr 28, 1:59 PM
This revision was automatically updated to reflect the committed changes.