Differential D8950

Makefile.sphinx: Add sphinx tag when building standalone package doc
ClosedPublic
Actions

Authored by anlambert on Dec 9 2022, 2:29 PM.

Details

Reviewers

ardumont

Group Reviewers

Reviewers

Maniphest Tasks

T4496: Refactor the doc.s.o structure

Commits

rDDOC8d04650792e1: Makefile.sphinx: Add sphinx tag when building standalone package doc

Summary

Add the standalone_package_doc sphinx tag when building standalone
documentation of a swh package.

It enables to conditionnally include content in package documentation,
like indices and tables for instance.

Related to T4496

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.Dec 9 2022, 2:29 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptDec 9 2022, 2:29 PM

anlambert added a child revision: D8951: docs: Include module indices only when building standalone package doc.Dec 9 2022, 2:31 PM

Build is green

Patch application report for D8950 (id=32250)

Rebasing onto b9c5018cfb...

Current branch diff-target is up to date.

Changes applied before test

commit aa61ceabf45796e2f7fe58316847cff431a655a2
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Fri Dec 9 14:14:09 2022 +0100

    Makefile.sphinx: Add sphinx tag when building standalone package doc
    
    Add the standalone_package_doc sphinx tag when building standalone
    documentation of a swh package.
    
    It enables to conditionnally include content in package documentation,
    like indices and tables for instance.
    
    Related to T4496

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

Harbormaster completed remote builds in B33205: Diff 32250.Dec 9 2022, 2:37 PM

anlambert requested review of this revision.Dec 9 2022, 2:37 PM

ardumont accepted this revision.Dec 12 2022, 5:22 PM

This revision is now accepted and ready to land.Dec 12 2022, 5:22 PM

Rebase

Build is green

Patch application report for D8950 (id=32308)

Rebasing onto 91afcdcfd7...

Current branch diff-target is up to date.

Changes applied before test

commit 8d04650792e10776fb14074010ba2dc49a883669
Author: Antoine Lambert <anlambert@softwareheritage.org>
Date:   Fri Dec 9 14:14:09 2022 +0100

    Makefile.sphinx: Add sphinx tag when building standalone package doc
    
    Add the standalone_package_doc sphinx tag when building standalone
    documentation of a swh package.
    
    It enables to conditionnally include content in package documentation,
    like indices and tables for instance.
    
    Related to T4496

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

Harbormaster completed remote builds in B33263: Diff 32308.Dec 19 2022, 1:23 PM

Closed by commit rDDOC8d04650792e1: Makefile.sphinx: Add sphinx tag when building standalone package doc (authored by anlambert). · Explain WhyDec 19 2022, 1:25 PM

This revision was automatically updated to reflect the committed changes.

anlambert added a commit: rDDOC8d04650792e1: Makefile.sphinx: Add sphinx tag when building standalone package doc.