Page MenuHomeSoftware Heritage

Remove 'Subpackages'/'Submodules'/'Module content' headings to clear the TOC
ClosedPublic

Authored by vlorentz on Mar 17 2021, 11:48 AM.

Details

Summary

They are polluting the doc by doubling the depth of the hierarchy
and provide no clear gain.

Also increase the depth of the generated TOC, so that we can see
the full module hierarchy instead of just the first level.

Central apidoc index

Before

After

swh.storage documentation

change is only at the bottom of the page

Before

After

swh-storage apidoc

Before

After

Diff Detail

Repository
rDDOC Development documentation
Branch
master
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 19956
Build 30986: arc lint + arc unit

Event Timeline

vlorentz edited the summary of this revision. (Show Details)
vlorentz added reviewers: moranegg, ardumont.

less levels, it was too big

anlambert added a subscriber: anlambert.

+1, much better indeed

This revision is now accepted and ready to land.Mar 17 2021, 12:10 PM

i like the result...

(but lolwat!? on the "how" ¯\_(ツ)_/¯, i'm not that much interested in the details though ;D)

(but lolwat!? on the "how" ¯\_(ツ)_/¯, i'm not that much interested in the details though ;D)

sphinx-apidoc generates .rst files from a template; I just changed that template