Page MenuHomeSoftware Heritage

tox: Add sphinx environments to check sane doc build
ClosedPublic

Authored by anlambert on Mon, Apr 26, 5:50 PM.

Details

Summary

Enable to check package documentation can be built without producing
sphinx warnings.

The sphinx environment is designed to be used in continuous integration
in order to prevent breaking documentation build when committing changes.

The sphinx-dev environment is designed to be used inside a full swh
development environment.

Related to T3258

I also added a commit to ensure tox can be successfully executed
in that template module and another commit to fix a duplicated
reference in the sample doc.

Diff Detail

Repository
rDTPL Python module template
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Harbormaster returned this revision to the author for changes because remote builds failed.Mon, Apr 26, 5:50 PM
Harbormaster failed remote builds in B21018: Diff 20020!
ardumont added a subscriber: ardumont.

lgtm

note that the build failed nonetheless (i did not look)

This revision is now accepted and ready to land.Mon, Apr 26, 6:15 PM

lgtm

note that the build failed nonetheless (i did not look)

Looks like the build of that repo dit not get configured on Jenkins.
Now that I fixed the tox build, we could add it I guess.