Differential D8951

docs: Include module indices only when building standalone package doc
ClosedPublic
Actions

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

Details

Reviewers

ardumont

Group Reviewers

Reviewers

Maniphest Tasks

T4496: Refactor the doc.s.o structure

Commits

rDCOREbff1e71c7c01: docs: Include module indices only when building standalone package doc

Summary

In order to remove warnings about /apidoc/*.rst files being included
multiple times in toc when building full swh documentation, prefer to
include module indices only when building standalone package documentation.

Also include them the proper sphinx way.

Related to T4496

Depends on D8950

Test Plan

Once that diff validated, I will push similar commits for all swh packages.

Diff Detail

Repository

rDCORE Foundations and core functionalities

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:31 PM

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

Build is green

Patch application report for D8951 (id=32251)

Rebasing onto 306a74d01a...

Current branch diff-target is up to date.

Changes applied before test

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

    docs: Include module indices only when building standalone package doc
    
    In order to remove warnings about /apidoc/*.rst files being included
    multiple times in toc when building full swh documentation, prefer to
    include module indices only when building standalone package documentation.
    
    Also include them the proper sphinx way.
    
    Related to T4496

See https://jenkins.softwareheritage.org/job/DCORE/job/tests-on-diff/491/ for more details.

Harbormaster completed remote builds in B33206: Diff 32251.Dec 9 2022, 2:34 PM

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

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

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

Closed by commit rDCOREbff1e71c7c01: docs: Include module indices only when building standalone package doc (authored by anlambert). · Explain WhyDec 19 2022, 1:28 PM

This revision was automatically updated to reflect the committed changes.

anlambert added a commit: rDCOREbff1e71c7c01: docs: Include module indices only when building standalone package doc.