Page MenuHomeSoftware Heritage

tox: Add sphinx environments to check sane doc build
ClosedPublic

Authored by anlambert on Mon, Apr 26, 4:08 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

Also add a commit to fix a sphinx warning since rDDOCa8ca608e4f532c203bfae126ebbe324cc82392b0.

Diff Detail

Repository
rDAUTH Common authentication libraries
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 D5593 (id=20001)

Rebasing onto bb90bd23c9...

Current branch diff-target is up to date.
Changes applied before test
commit 5b08338c89bb3551ebd39fa04e4bac6d309890d3
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 16:06:58 2021 +0200

    pytest_plugin: Fix a sphinx warning
    
    Sphinx complains about an unexpected indentation if a constructor
    docstring is missing.

commit 7b642fc76d267e1b9b0ddd8a25a681970d2b9c38
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 15:48:41 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/DAUTH/job/tests-on-diff/79/ for more details.

This revision is now accepted and ready to land.Mon, Apr 26, 4:38 PM

Build is green

Patch application report for D5593 (id=20001)

Rebasing onto bb90bd23c9...

Current branch diff-target is up to date.
Changes applied before test
commit 5b08338c89bb3551ebd39fa04e4bac6d309890d3
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 16:06:58 2021 +0200

    pytest_plugin: Fix a sphinx warning
    
    Sphinx complains about an unexpected indentation if a constructor
    docstring is missing.

commit 7b642fc76d267e1b9b0ddd8a25a681970d2b9c38
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 15:48:41 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/DAUTH/job/tests-on-diff/80/ for more details.

Build is green

Patch application report for D5593 (id=20050)

Rebasing onto bb90bd23c9...

Current branch diff-target is up to date.
Changes applied before test
commit dc9ea01da8d62eac3a768f01ad4726af3add662e
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 15:48:41 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

commit a81214a8aada047007c4ef481394c9a043ac51eb
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Mon Apr 26 16:06:58 2021 +0200

    pytest_plugin: Fix a sphinx warning
    
    Sphinx complains about an unexpected indentation if a constructor
    docstring is missing.

See https://jenkins.softwareheritage.org/job/DAUTH/job/tests-on-diff/81/ for more details.