tox: Add sphinx environments to check sane doc build
ClosedPublic
Actions

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

Details

Reviewers

ardumont

Group Reviewers

Reviewers

Maniphest Tasks

T3258: Build documentation on every diff

Commits

rDTPL0c54367e9fbe: tox: Add sphinx environments to check sane doc build
rDTPL5a7889e3d1f1: docs: Fix duplicate reference target
rDTPL508ae720eaba: setup.py: Ensure tox command use will be successful

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

anlambert created this revision.Apr 26 2021, 5:50 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptApr 26 2021, 5:50 PM

Harbormaster returned this revision to the author for changes because remote builds failed.Apr 26 2021, 5:50 PM

Harbormaster failed remote builds in B21018: Diff 20020!

anlambert requested review of this revision.Apr 26 2021, 5:56 PM

lgtm

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

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

In D5610#142331, @ardumont wrote:

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.

This revision was landed with ongoing or failed builds.Apr 27 2021, 1:58 PM

Closed by commit rDTPL508ae720eaba: setup.py: Ensure tox command use will be successful (authored by anlambert). · Explain Why

This revision was automatically updated to reflect the committed changes.

anlambert added a commit: rDTPL508ae720eaba: setup.py: Ensure tox command use will be successful.

anlambert added a commit: rDTPL5a7889e3d1f1: docs: Fix duplicate reference target.

anlambert added a commit: rDTPL0c54367e9fbe: tox: Add sphinx environments to check sane doc build.

Revision Contents
Changeset List

Path

Size

setup.py

6 lines

Diff 20042

View Options

tox: Add sphinx environments to check sane doc buildClosedPublicActions