Differential D8822

conftest.py files from apidoc processing
ClosedPublic
Actions

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

Details

Reviewers

ardumont

Group Reviewers

Reviewers

Commits

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

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

anlambert created this revision.Nov 8 2022, 3:24 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptNov 8 2022, 3:24 PM

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.Nov 8 2022, 3:43 PM

Harbormaster failed remote builds in B32753: Diff 31812!

Also modify docs/Makefile

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.

Harbormaster completed remote builds in B32754: Diff 31813.Nov 8 2022, 4:06 PM

anlambert requested review of this revision.Nov 8 2022, 4:06 PM

ardumont accepted this revision.Nov 8 2022, 4:08 PM

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

Closed by commit rDDOCce3cd5dcd05f: Makefile.sphinx: Exclude swh/*/conftest.py files from apidoc processing (authored by anlambert). · Explain WhyNov 8 2022, 4:10 PM

This revision was automatically updated to reflect the committed changes.

anlambert added a commit: rDDOCce3cd5dcd05f: Makefile.sphinx: Exclude swh/*/conftest.py files from apidoc processing.