Page MenuHomeSoftware Heritage

Fix various Sphinx warnings
ClosedPublic

Authored by vlorentz on Apr 13 2021, 9:48 PM.

Details

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

ardumont added a subscriber: ardumont.

lgtm

I have some questions inline.

docs/architecture/mirror.rst
113

What's the difference between the 2?

docs/archive-changelog.rst
28

So is it 1 or 2 underscores for a link in the end?

This revision is now accepted and ready to land.Apr 14 2021, 9:28 AM
docs/architecture/mirror.rst
113

:ref: points to an explicit target, defined with .. _swh.storage.replay:. https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-arbitrary-locations

:mod: points to a module definition, defined with .. py:mod:. https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html

docs/archive-changelog.rst
28

1 underscore is a named reference, 2 underscores is anonymous. you can't have multiple named refs with the same name (here, "announcement").

Not sure what is the point of named refs.

This revision was automatically updated to reflect the committed changes.