Page MenuHomeSoftware Heritage

docs/Makefile: Fix warning about file not being included in any toctree
ClosedPublic

Authored by anlambert on Feb 22 2022, 12:12 PM.

Details

Summary

Do not generate TOC with sphinx-apidoc.

Mark the apidoc/swh.rst file as orphan.

This should turn the doc dev build [1] on Jenkins green again once
rebased on top of D7218.

[1] https://jenkins.softwareheritage.org/job/DDOC/job/dev/871/console

Depends on D7218

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 D7219 (id=26162)

Rebasing onto db089e81a2...

Current branch diff-target is up to date.
Changes applied before test
commit a03bbfb3e6b8b2f39e1037fd06522f0196f0eb41
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Tue Feb 22 12:07:23 2022 +0100

    docs/Makefile: Fix warning about file not being included in any toctree
    
    Do not generate TOC with sphinx-apidoc.
    
    Mark the apidoc/swh.rst file as orphan.

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

Harbormaster returned this revision to the author for changes because remote builds failed.Feb 22 2022, 12:22 PM
Harbormaster failed remote builds in B27035: Diff 26162!

lgtm but i can't validate it (nor publish it) [1]

[1] I could some time ago do first a publish that revision and then a validate (even with a red build ¯\_(ツ)_/¯)

ardumont edited the summary of this revision. (Show Details)

Build has FAILED

Patch application report for D7219 (id=26162)

Rebasing onto db089e81a2...

Current branch diff-target is up to date.
Changes applied before test
commit a03bbfb3e6b8b2f39e1037fd06522f0196f0eb41
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Tue Feb 22 12:07:23 2022 +0100

    docs/Makefile: Fix warning about file not being included in any toctree
    
    Do not generate TOC with sphinx-apidoc.
    
    Mark the apidoc/swh.rst file as orphan.

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

Build is green

Patch application report for D7219 (id=26166)

Rebasing onto 955b180024...

Current branch diff-target is up to date.
Changes applied before test
commit 6aa5f08095e9f7200b6a4f6b056392c40509c66a
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Tue Feb 22 12:07:23 2022 +0100

    docs/Makefile: Fix warning about file not being included in any toctree
    
    Do not generate TOC with sphinx-apidoc.
    
    Mark the apidoc/swh.rst file as orphan.

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

This revision is now accepted and ready to land.Feb 22 2022, 2:29 PM