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

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

Details

Reviewers

ardumont

Group Reviewers

Reviewers

Maniphest Tasks

T3258: Build documentation on every diff

Commits

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

rDGRPH Compressed graph representation

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

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

Build is green

Patch application report for D5597 (id=20006)

Rebasing onto e8f052a340...

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 4c986d3c91dbc00bc237589216e136697d63435f
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 16:22:20 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/DGRPH/job/tests-on-diff/96/ for more details.

Harbormaster completed remote builds in B21004: Diff 20006.Apr 26 2021, 4:24 PM

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

ardumont accepted this revision.Apr 26 2021, 6:13 PM

This revision is now accepted and ready to land.Apr 26 2021, 6:13 PM

Build is green

Patch application report for D5597 (id=20006)

Rebasing onto e8f052a340...

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 d8ed9a7661c3dba22034c7ce267a4e2bdae6aef4
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 16:22:20 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/DGRPH/job/tests-on-diff/97/ for more details.

Rebase

Build is green

Patch application report for D5597 (id=20046)

Rebasing onto e8f052a340...

Current branch diff-target is up to date.

Changes applied before test

commit f049e264c071279684115a980c37cde225efb9c5
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 16:22:20 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/DGRPH/job/tests-on-diff/98/ for more details.

Harbormaster completed remote builds in B21040: Diff 20046.Apr 27 2021, 2:03 PM

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

This revision was automatically updated to reflect the committed changes.

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