From c69cd21296ede120b58285bdb00dfae8c97fca17 Mon Sep 17 00:00:00 2001 From: Jeff Ohrstrom Date: Mon, 19 Aug 2024 16:31:24 -0400 Subject: [PATCH] update README to use new container image name (#19) --- README.md | 40 ++++++---------------------------------- 1 file changed, 6 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index c4b27d5..efa992c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Docker Sphinx +# OOD Documentation build container Docker image for [Sphinx](http://www.sphinx-doc.org/en/stable/). @@ -14,47 +14,19 @@ This image contains: ## Build ```sh -git clone https://github.com/OSC/docker-sphinx.git -cd docker-sphinx -docker build --force-rm -t ohiosupercomputer/docker-sphinx . +git clone https://github.com/OSC/ood-documentation-build.git +cd ood-documentation-build +docker build --force-rm -t ohiosupercomputer/ood-doc-build . ``` ## Install ```sh -docker pull ohiosupercomputer/docker-sphinx +docker pull ohiosupercomputer/ood-doc-build ``` ## Usage ```sh -docker run --rm -i -t -v "${PWD}:/doc" -u "$(id -u):$(id -g)" ohiosupercomputer/docker-sphinx -``` - -### Docker Compose - -It is recommended to use [Docker Compose](https://docs.docker.com/compose/). An -example `docker-compose.yml` is seen as: - -```yaml -version: "2" -services: - sphinx: - image: "ohiosupercomputer/docker-sphinx" - volumes: - - "${PWD}:/doc" - user: "1000:1000" -``` - -Then run: - -```sh -docker-compose run --rm sphinx -``` - -Examples: - -```sh -docker-compose run --rm sphinx sphinx-quickstart -docker-compose run --rm sphinx make html +docker run --rm -i -t -v "${PWD}:/doc" -u "$(id -u):$(id -g)" ohiosupercomputer/ood-doc-build ```