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

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

Details

Reviewers

None

Group Reviewers

Reviewers

Maniphest Tasks

T3258: Build documentation on every diff

Commits

rDMFCD3f73d9723d2b: 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

rDMFCD ClearlyDefined metadata fetcher

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:50 PM

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

Build is green

Patch application report for D5604 (id=20014)

Rebasing onto c299d0db5f...

Current branch diff-target is up to date.

Changes applied before test

commit 3f73d9723d2b4524558bb8b470b43670f74b26f7
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 16:50:08 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/DMFCD/job/tests-on-diff/128/ for more details.

Harbormaster completed remote builds in B21012: Diff 20014.Apr 26 2021, 4:51 PM

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

Build is green

Patch application report for D5604 (id=20014)

Rebasing onto c299d0db5f...

Current branch diff-target is up to date.

Changes applied before test

commit 3f73d9723d2b4524558bb8b470b43670f74b26f7
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 16:50:08 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/DMFCD/job/tests-on-diff/129/ for more details.

This revision was not accepted when it landed; it landed in state Needs Review.Apr 28 2021, 2:04 PM

Closed by commit rDMFCD3f73d9723d2b: tox: Add sphinx environments to check sane doc build (authored by anlambert). · Explain Why

This revision was automatically updated to reflect the committed changes.

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