sphinx/conf.py: Merge swh-web sphinx config into root conf.py file
ClosedPublic
Actions

Authored by anlambert on Apr 20 2021, 5:33 PM.

Details

Reviewers

ardumont

Group Reviewers

Reviewers

Maniphest Tasks

T3258: Build documentation on every diff

Commits

rDDOC51cb3ebfaca2: sphinx/conf.py: Merge swh-web sphinx config into root conf.py file

Summary

It enables to not depend on swh-web to build standalone swh package
documentation, plus these sphinx features could be reused in other
package documentation.

Related to T3258

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

anlambert created this revision.Apr 20 2021, 5:33 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptApr 20 2021, 5:33 PM

anlambert requested review of this revision.Apr 20 2021, 5:33 PM

Harbormaster completed remote builds in B20888: Diff 19878.Apr 20 2021, 5:33 PM

anlambert added a child revision: D5566: docs: Remove doc_config module and its use.Apr 20 2021, 5:34 PM

anlambert added a child revision: D5567: sphin/conf.py: Improve django settings handling.Apr 20 2021, 5:59 PM

vlorentz added a subscriber: vlorentz.Apr 20 2021, 6:34 PM

vlorentz added inline comments.

swh/docs/sphinx/conf.py
170–173	why do we need this? When does it trigger?

anlambert added inline comments.Apr 20 2021, 6:46 PM

swh/docs/sphinx/conf.py
170–173	It is used to embed Web API endpoints docstrings into sphinx documentation for swh-web URLs, for instance the Web API ones. It enables to remove the header with the endpoint implementation function signature and remove indentation. This will be removed at some point but `swh-web` still needs it at the moment.