Page MenuHomeSoftware Heritage

docs/Makefile: Fix local build of global swh documentation
ClosedPublic

Authored by anlambert on Aug 23 2022, 12:06 PM.

Details

Summary

It can be convenient to run the global swh documentation in the
current venv instead of using tox (notably to save time by skipping
dependencies installation).

It looks like the Makefile in docs folder was not really maintained
regarding that kind of documentation build so fix it in order to
restore local build.

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 D8291 (id=29939)

Rebasing onto 480ec26a4f...

Current branch diff-target is up to date.
Changes applied before test
commit 1f57b029c3733c959907f576e0a48cbfcd5dad6d
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Tue Aug 23 11:37:00 2022 +0200

    docs/Makefile: Fix local build of global swh documentation
    
    It can be convenient to run the global swh documentation in the
    current venv instead of using tox (notably to save time by skipping
    dependencies installation).
    
    It looks like the Makefile in docs folder was not really maintained
    regarding that kind of documentation build so fix it in order to
    restore local build.

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

Harbormaster returned this revision to the author for changes because remote builds failed.Aug 23 2022, 12:14 PM
Harbormaster failed remote builds in B30991: Diff 29939!

Fix swh-deposit images build

Build has FAILED

Patch application report for D8291 (id=29943)

Rebasing onto 480ec26a4f...

Current branch diff-target is up to date.
Changes applied before test
commit 83b4deb98334733fe23073c3e1fdfa0c43b40e82
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Tue Aug 23 11:37:00 2022 +0200

    docs/Makefile: Fix local build of global swh documentation
    
    It can be convenient to run the global swh documentation in the
    current venv instead of using tox (notably to save time by skipping
    dependencies installation).
    
    It looks like the Makefile in docs folder was not really maintained
    regarding that kind of documentation build so fix it in order to
    restore local build.

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

Harbormaster returned this revision to the author for changes because remote builds failed.Aug 23 2022, 1:26 PM
Harbormaster failed remote builds in B30995: Diff 29943!

Restore symbolic links to swh module doc folders, they are required to build the global API index.

Build has FAILED

Patch application report for D8291 (id=29947)

Rebasing onto 480ec26a4f...

Current branch diff-target is up to date.
Changes applied before test
commit bc9b5b4a9d7143f9d0b0539ac5c2b131e6a6d247
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Tue Aug 23 11:37:00 2022 +0200

    docs/Makefile: Fix local build of global swh documentation
    
    It can be convenient to run the global swh documentation in the
    current venv instead of using tox (notably to save time by skipping
    dependencies installation).
    
    It looks like the Makefile in docs folder was not really maintained
    regarding that kind of documentation build so fix it in order to
    restore local build.

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

Harbormaster returned this revision to the author for changes because remote builds failed.Aug 23 2022, 2:30 PM
Harbormaster failed remote builds in B30999: Diff 29947!

Exclude some markdown files not included in global doc.

Build is green

Patch application report for D8291 (id=29950)

Rebasing onto 480ec26a4f...

Current branch diff-target is up to date.
Changes applied before test
commit ba2e0d082b335e753dea2fce6c36c81e944cec1e
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Tue Aug 23 11:37:00 2022 +0200

    docs/Makefile: Fix local build of global swh documentation
    
    It can be convenient to run the global swh documentation in the
    current venv instead of using tox (notably to save time by skipping
    dependencies installation).
    
    It looks like the Makefile in docs folder was not really maintained
    regarding that kind of documentation build so fix it in order to
    restore local build.

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

This revision is now accepted and ready to land.Aug 24 2022, 5:47 PM
This revision was landed with ongoing or failed builds.Aug 24 2022, 6:03 PM
This revision was automatically updated to reflect the committed changes.

Build is green

Patch application report for D8291 (id=29995)

Rebasing onto 99264b0b91...

Current branch diff-target is up to date.
Changes applied before test
commit 79efac6b306deac5dd141a4a5b9f62a543e0718f
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Tue Aug 23 11:37:00 2022 +0200

    docs/Makefile: Fix local build of global swh documentation
    
    It can be convenient to run the global swh documentation in the
    current venv instead of using tox (notably to save time by skipping
    dependencies installation).
    
    It looks like the Makefile in docs folder was not really maintained
    regarding that kind of documentation build so fix it in order to
    restore local build.

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