Page MenuHomeSoftware Heritage

tox: Add sphinx environments to check sane doc build
ClosedPublic

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

Details

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 Graph service
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

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.

This revision is now accepted and ready to land.Mon, Apr 26, 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.

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.