https://github.com/andyneff/docker-robodoc
Docker for robodoc
https://github.com/andyneff/docker-robodoc
Last synced: about 2 months ago
JSON representation
Docker for robodoc
- Host: GitHub
- URL: https://github.com/andyneff/docker-robodoc
- Owner: andyneff
- License: mit
- Created: 2017-05-13T19:29:22.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-24T23:31:26.000Z (about 9 years ago)
- Last Synced: 2025-01-15T19:43:00.305Z (over 1 year ago)
- Language: Shell
- Size: 3.91 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ROBODoc
Docker container for running ROBODoc
## Usage
```
docker run --rm \
-v :/src \
-v :/doc \
-e DOCKER_UID=$(id -u) \
-e DOCKER_GID=$(id -g) \
andyneff/robodoc:latest
```
or using the `docker-compose.yml` file
```
SRC_DIR= DOC_DIR= DOCKER_UID= DOCKER_GID= docker-compose run
```
- SRC_DIR default is `.`
- DOC_DIR default is `./docs`
- DOCKER_UID default is 1000
- DOCKER_GID default is 1000
### Example
```
DOCKER_UID=$(id -u) DOCKER_GID=$(id -g) docker-compose run robodoc --multidoc --html
```