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

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

Details

Reviewers

None

Group Reviewers

Reviewers

Maniphest Tasks

T3258: Build documentation on every diff

Commits

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

rDMOD Data model

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, 5:15 PM

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

Build is green

Patch application report for D5606 (id=20016)

Rebasing onto 1f6b3b9d5b...

Current branch diff-target is up to date.

Changes applied before test

commit a4a05cfe470975af1e9ae8ab2aec3e62f3aeefd2
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 17:13:42 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/DMOD/job/tests-on-diff/321/ for more details.

Harbormaster completed remote builds in B21014: Diff 20016.Apr 26 2021, 5:16 PM

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

Build is green

Patch application report for D5606 (id=20016)

Rebasing onto 446bd2b167...

First, rewinding head to replay your work on top of it...
Applying: tox: Add sphinx environments to check sane doc build

Changes applied before test

commit 71106c55a459ddf5d2da20b989dc94f2f3ed83eb
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 17:13:42 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/DMOD/job/tests-on-diff/322/ for more details.

Rebase

Build is green

Patch application report for D5606 (id=20100)

Rebasing onto 446bd2b167...

Current branch diff-target is up to date.

Changes applied before test

commit f7e9d5c290731c7a7fa104a9fcc8e60b6004dc70
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 17:13:42 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/DMOD/job/tests-on-diff/323/ for more details.

Harbormaster completed remote builds in B21092: Diff 20100.Apr 28 2021, 2:04 PM

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

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