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

Authored by anlambert on Apr 26 2021, 5:21 PM.

Details

Reviewers

None

Group Reviewers

Reviewers

Maniphest Tasks

T3258: Build documentation on every diff

Commits

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

rDFUSE FUSE virtual file system

Branch

tox-sphinx

Lint

No Linters Available

Unit

No Unit Test Coverage

Build Status

Buildable 21016
Build 32623: Phabricator diff pipeline on jenkins	Jenkins console · Jenkins
Build 32622: arc lint + arc unit

Event Timeline

anlambert created this revision.Apr 26 2021, 5:21 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptApr 26 2021, 5:21 PM

Build is green

Patch application report for D5608 (id=20018)

Rebasing onto b81d0c9893...

Current branch diff-target is up to date.

Changes applied before test

commit 1b2b6f3359baa940715305914cc433d3cf6e265f
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 17:21: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/DFUSE/job/tests-on-diff/277/ for more details.

Harbormaster completed remote builds in B21016: Diff 20018.Apr 26 2021, 5:25 PM

anlambert requested review of this revision.Apr 26 2021, 5:25 PM

Build is green

Patch application report for D5608 (id=20018)

Rebasing onto b81d0c9893...

Current branch diff-target is up to date.

Changes applied before test

commit 1b2b6f3359baa940715305914cc433d3cf6e265f
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 17:21: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/DFUSE/job/tests-on-diff/278/ for more details.

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

Closed by commit rDFUSE1b2b6f3359ba: 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: rDFUSE1b2b6f3359ba: tox: Add sphinx environments to check sane doc build.