We need to review all the TOCs in the doc, because most of them are broken.
- We should remove :orphan: blocks, pages should always be referenced
in a TOC. When a page is marked as :orphan:, accessing it will not
show its position in the navigation hierarchy.
- We should remove "manual" TOCs using :ref:, as those don't count for
the global TOC. All the TOCs should be put in a ".. toctree::" block,
using :caption: if needed to present it properly in a separate
section.
- Each page should always have one title as the top-level header.
Here is the list of modules that need to be reviewed and the associated diffs:
- swh.core
- [x] swh.dataset (seirl)
- [x] swh.deposit
- swh.graph (seirl) -> https://forge.softwareheritage.org/D1956
- swh.indexer
- swh.journal
- swh.lister
- swh.loader
- [x] swh.model (seirl) -> https://forge.softwareheritage.org/D1941
- swh.objstorage
- swh.scheduler
- swh.storage
- swh.vault
- swh.web