Page MenuHomeSoftware Heritage

Fix Sphinx 2.x warnings
ClosedPublic

Authored by anlambert on Feb 3 2020, 2:59 PM.

Details

Summary

This fixes the following Sphinx 2.x warnings in swh-web:

/home/antoine/swh/swh-environment/swh-web/swh/web/browse/utils.py:docstring of swh.web.browse.utils.get_snapshot_context:: WARNING: plusieurs cibles trouvées pour le renvoi 'NotFoundExc' : swh.vault.backend.NotFoundExc, swh.web.common.exc.NotFoundExc
/home/antoine/swh/swh-environment/swh-web/swh/web/common/origin_save.py:docstring of swh.web.common.origin_save.get_save_origin_requests:: WARNING: plusieurs cibles trouvées pour le renvoi 'NotFoundExc' : swh.vault.backend.NotFoundExc, swh.web.common.exc.NotFoundExc
/home/antoine/swh/swh-environment/swh-web/swh/web/common/origin_visits.py:docstring of swh.web.common.origin_visits.get_origin_visits:: WARNING: plusieurs cibles trouvées pour le renvoi 'NotFoundExc' : swh.vault.backend.NotFoundExc, swh.web.common.exc.NotFoundExc
/home/antoine/swh/swh-environment/swh-web/swh/web/common/service.py:docstring of swh.web.common.service.lookup_revision_log:: WARNING: plusieurs cibles trouvées pour le renvoi 'NotFoundExc' : swh.vault.backend.NotFoundExc, swh.web.common.exc.NotFoundExc
/home/antoine/swh/swh-environment/swh-web/swh/web/common/service.py:docstring of swh.web.common.service.lookup_revision_log_by:: WARNING: plusieurs cibles trouvées pour le renvoi 'NotFoundExc' : swh.vault.backend.NotFoundExc, swh.web.common.exc.NotFoundExc
/home/antoine/swh/swh-environment/swh-web/swh/web/common/service.py:docstring of swh.web.common.service.lookup_object:: WARNING: plusieurs cibles trouvées pour le renvoi 'NotFoundExc' : swh.vault.backend.NotFoundExc, swh.web.common.exc.NotFoundExc

This raises the question that maybe we should centralize common used exceptions in swh-core
but first let's simply fix the documentation build on Jenkins.

Related to T2264

Diff Detail

Repository
rDWAPPS Web applications
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.Feb 3 2020, 2:59 PM
vlorentz accepted this revision.Feb 3 2020, 3:25 PM
vlorentz added a subscriber: vlorentz.

You're stealing easy hacks again :/

This revision is now accepted and ready to land.Feb 3 2020, 3:25 PM

You're stealing easy hacks again :/

I known but I am sick and that the best that I can do today ...

I let the other warnings for newcomers then.

I known but I am sick and that the best that I can do today ...

You should rest!

anlambert updated this revision to Diff 9363.Feb 3 2020, 3:58 PM

Reference Easy hack task in commit message instead

Easy hack task to fix documentation warnings created: T2265

Landing this and going back to rest.

This revision was landed with ongoing or failed builds.Feb 3 2020, 4:05 PM
This revision was automatically updated to reflect the committed changes.