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

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

Details

Reviewers

None

Group Reviewers

Reviewers

Maniphest Tasks

T3258: Build documentation on every diff

Commits

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

rDOBJS Object storage

Branch

tox-sphinx

Lint

No Linters Available

Unit

No Unit Test Coverage

Build Status

Buildable 21015
Build 32621: Phabricator diff pipeline on jenkins	Jenkins console · Jenkins
Build 32620: arc lint + arc unit

Event Timeline

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

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

Build is green

Patch application report for D5607 (id=20017)

Rebasing onto e92746e15d...

Current branch diff-target is up to date.

Changes applied before test

commit 326fcef47b3ad7e165b60cdfc344e262c581014f
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 17:18:40 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/DOBJS/job/tests-on-diff/20/ for more details.

Harbormaster completed remote builds in B21015: Diff 20017.Apr 26 2021, 5:20 PM

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

Build is green

Patch application report for D5607 (id=20017)

Rebasing onto e92746e15d...

Current branch diff-target is up to date.

Changes applied before test

commit 326fcef47b3ad7e165b60cdfc344e262c581014f
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 17:18:40 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/DOBJS/job/tests-on-diff/21/ 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 rDOBJS326fcef47b3a: 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: rDOBJS326fcef47b3a: tox: Add sphinx environments to check sane doc build.