Page MenuHomeSoftware Heritage

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

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

Details

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
Branch
merge-swh-web-doc-conf
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 20895
Build 32425: arc lint + arc unit

Event Timeline

vlorentz added inline comments.
swh/docs/sphinx/conf.py
170–173

why do we need this? When does it trigger?

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.

swh/docs/sphinx/conf.py
170–173

Thx. Can you add this explaination in the docstring?

Improve SimpleDocumenter doctring.

This revision is now accepted and ready to land.Apr 21 2021, 12:01 PM