roc-streaming / roc-toolkit

Real-time audio streaming over the network.
https://roc-streaming.org
Mozilla Public License 2.0
1.03k stars 205 forks source link

Add docker image with pre-installed sphinx #561

Closed gavv closed 8 months ago

gavv commented 9 months ago

We need to create docker image for reproducible documentation builds.

First, we should add new image env-sphinx to dockerfiles repo: https://github.com/roc-streaming/dockerfiles

It should have 3 python modules pre-installed:

And also system packages:

Python module versions should be freezed using pip and saved to requirements.txt.

Then we need to switch web site build github action to use new docker image for building documentation: https://github.com/roc-streaming/roc-streaming.github.io/blob/source/.github/workflows/build.yaml

Note: docker should be used only for building step, but not for the publishing step.

Documentation for our CI and docker images is available here: https://roc-streaming.org/toolkit/docs/development/continuous_integration.html

nolan-veed commented 8 months ago

I can do this.

nolan-veed commented 8 months ago

I've done the image bit.

For the https://github.com/roc-streaming/roc-streaming.github.io/blob/source/.github/workflows/build.yaml change, I think we need some scripts from the main repo, so that we can do docker image runs to build the documentation.

Or shall I just write one here?

gavv commented 8 months ago

Thanks!

I think we need some scripts from the main repo, so that we can do docker image runs to build the documentation.

Do you mean scripts/ci_checks/docker.sh? I think we can just copy command from it.

nolan-veed commented 8 months ago

(Was away for 2 weeks - continuing on this.)

gavv commented 8 months ago

Landed!