Page MenuHomeSoftware Heritage

Makefile.sphinx: Exclude swh/*/conftest.py files from apidoc processing
ClosedPublic

Authored by anlambert on Tue, Nov 8, 3:24 PM.

Details

Summary

Such files are not of interest for API documentation and can generate doc
build errors.

Since swh-web tests reorganization, we now have such file so we need to
exclude it from apidoc processing.

Diff Detail

Repository
rDDOC Development documentation
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Build has FAILED

Patch application report for D8822 (id=31812)

Rebasing onto 5afff2c092...

Current branch diff-target is up to date.
Changes applied before test
commit 62ffa9f6c31a20860a2b71b214d80636b9e534e5
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Tue Nov 8 15:22:14 2022 +0100

    Makefile.sphinx: Exclude swh/*/conftest.py files from apidoc processing
    
    Such files are not of interest for API documentation and can generate doc
    build errors.
    
    Since swh-web tests reorganization, we now have such file so we need to
    exclude it from apidoc processing.

Link to build: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/253/
See console output for more information: https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/253/console

Harbormaster returned this revision to the author for changes because remote builds failed.Tue, Nov 8, 3:43 PM
Harbormaster failed remote builds in B32753: Diff 31812!

Build is green

Patch application report for D8822 (id=31813)

Rebasing onto 5afff2c092...

Current branch diff-target is up to date.
Changes applied before test
commit ce3cd5dcd05f6df9a4eeadcf83ae3babcc2e6397
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Tue Nov 8 15:22:14 2022 +0100

    Makefile.sphinx: Exclude swh/*/conftest.py files from apidoc processing
    
    Such files are not of interest for API documentation and can generate doc
    build errors.
    
    Since swh-web tests reorganization, we now have such file so we need to
    exclude it from apidoc processing.

See https://jenkins.softwareheritage.org/job/DDOC/job/build-on-diff/254/ for more details.

This revision is now accepted and ready to land.Tue, Nov 8, 4:08 PM