tox: Add sphinx environments to check sane doc build
ClosedPublic
Actions

Authored by anlambert on Apr 26 2021, 4:32 PM.

Details

Reviewers

ardumont

Group Reviewers

Reviewers

Maniphest Tasks

T3258: Build documentation on every diff

Commits

rDJNLdd59b67c7fb7: tox: Add sphinx environments to check sane doc build

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

anlambert created this revision.Apr 26 2021, 4:32 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptApr 26 2021, 4:32 PM

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.

Harbormaster completed remote builds in B21007: Diff 20009.Apr 26 2021, 4:35 PM

anlambert requested review of this revision.Apr 26 2021, 4:35 PM

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.

ardumont accepted this revision.Apr 27 2021, 4:33 PM

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

Closed by commit rDJNLdd59b67c7fb7: tox: Add sphinx environments to check sane doc build (authored by anlambert). · Explain WhyApr 27 2021, 4:48 PM

This revision was automatically updated to reflect the committed changes.

anlambert added a commit: rDJNLdd59b67c7fb7: tox: Add sphinx environments to check sane doc build.