databricksdocs/sphinx repository overview

⁠Databricks Sphinx

Dockerfile and any other required configuration required to build the Databricks docs Sphinx build image.

⁠Usage

The build process is simple. You start from the root of the docs⁠ repository, declare the version of the container you intend to build, then build the image.

Image versions follow (very roughly) semantic versioning⁠. To find the next image version number you can simply check the current image version and increment the appropriate part of the version number based on the number and depth of the changes you're making.

export IMAGE_VERSION=v0.0.4 

docker build -t databricksdocs/sphinx:${IMAGE_VERSION} -f shared/docker/sphinx/Dockerfile .

⁠Quick and dirty changes

If you need to make changes to the image and don't necessarily care to wait for the whole image build process to complete you can run the current version of the image, make the changes you need to make, then commit that container as a new version of the image with a lowercase letter appended to the end of the existing version.

docker run --rm --name sphinx -it databricksdocs/sphinx:${IMAGE_VERSION} bash

Update the container with your changes from the provided prompt, then commit and push the updated version.

docker commit -m "Updated sphinx image" sphinx databricksdocs/sphinx:${IMAGE_VERSION}a
docker push databricksdocs/sphinx:${IMAGE_VERSION}a