Page MenuHomeSoftware Heritage

tox: Add sphinx environments to check sane doc build
ClosedPublic

Authored by anlambert on Mon, Apr 26, 4:32 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
rDJNL Journal infrastructure
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 D5599 (id=20009)

Rebasing onto 236a00262e...

Current branch diff-target is up to date.
Changes applied before test
commit dd59b67c7fb76bc808d40c25819a48ceae2c636b
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 16:32:26 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/DJNL/job/tests-on-diff/157/ for more details.

Build is green

Patch application report for D5599 (id=20009)

Rebasing onto 236a00262e...

Current branch diff-target is up to date.
Changes applied before test
commit dd59b67c7fb76bc808d40c25819a48ceae2c636b
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 16:32:26 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/DJNL/job/tests-on-diff/159/ for more details.

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