Skip to content

Commit

Permalink
update README to use new container image name (#19)
Browse files Browse the repository at this point in the history
  • Loading branch information
johrstrom authored Aug 19, 2024
1 parent 348cb24 commit c69cd21
Showing 1 changed file with 6 additions and 34 deletions.
40 changes: 6 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Docker Sphinx
# OOD Documentation build container

Docker image for [Sphinx](http://www.sphinx-doc.org/en/stable/).

Expand All @@ -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 <cmd>
```

### 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 <cmd>
```

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 <cmd>
```

0 comments on commit c69cd21

Please sign in to comment.