Page MenuHomeSoftware Heritage

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

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

Details

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

Event Timeline

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.

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