Page MenuHomeSoftware Heritage

templates/swh-pipeline: Add stage to build sphinx documentation
ClosedPublic

Authored by anlambert on Apr 26 2021, 6:43 PM.

Details

Summary

If it exists a sphinx tox environment in the built project, it will
be executed to build sphinx documentation and check for errors.

Related to T3258

Diff Detail

Repository
rCJSWH Jenkins jobs
Branch
pipeline-add-sphinx-doc-build
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 21032
Build 32646: arc lint + arc unit

Event Timeline

anlambert created this revision.
olasd added a subscriber: olasd.

Please mount the shared cache directory in the image to avoid re-downloading all of PyPI from the internet on every build. I'd suggest duplicating the existing includes/agent-docker.groovy.j2 to a new agent-docker-sphinx.groovy.j2 file, to add the options relevant for this build (for instance, I don't know how useful mounting a tmpdir on /tmp would be).

jobs/templates/swh-pipeline.groovy.j2
105
This revision is now accepted and ready to land.Apr 26 2021, 7:17 PM

Remove tmpfs mount on sphinx docker container, should not be needed to build sphinx doc