https://github.com/omegat-org/docgen-docker
Docker container for generating OmegaT docs
https://github.com/omegat-org/docgen-docker
docker documentation
Last synced: 5 months ago
JSON representation
Docker container for generating OmegaT docs
- Host: GitHub
- URL: https://github.com/omegat-org/docgen-docker
- Owner: omegat-org
- License: mit
- Created: 2019-03-21T14:28:16.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-01-07T01:58:12.000Z (over 1 year ago)
- Last Synced: 2025-01-07T02:41:25.251Z (over 1 year ago)
- Topics: docker, documentation
- Language: Dockerfile
- Homepage: https://hub.docker.com/repository/docker/omegatorg/docgen
- Size: 7.81 KB
- Stars: 0
- Watchers: 5
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docgen-docker
This project defines an OCI standard container for generating [OmegaT](https://omegat.org) documents.
## Requirements to run
To generate container images, you need to prepare container runtime, and OCI standard CLI.
It supports aarch64/ARM64 and x86_64/AMD64 platform architectures.
You have several options;
### integrated desktop application: Docker Desktop or Rancher Desktop
- [Docker](https://www.docker.com/products/docker-desktop)
- [Rancher Desktop](https://rancherdesktop.io/)
### Linux native OCI runtime and CLI tool
- [Containerd](https://containerd.io/)
- [nerdctl](https://github.com/containerd/nerdctl)
## Usage
Invoke from the OmegaT `doc_src` dir as so:
```shell
docker run -i --rm -v $(dirname $PWD):/work/root omegatorg/docgen -Dlanguage=en html
```
The arguments after `omegatorg/docgen` are those supplied to `ant` according
to the developer manual's section [Manual build using container](https://omegat.readthedocs.io/en/latest/07.ManualBuildUsingContainer/)
and [building the documentation manually](https://omegat.readthedocs.io/en/latest/08.ManuallyBuildDocumentation/).
You may want to create a wrapper script like the following, named
e.g. `docgen`:
```shell
#!/bin/sh
exec docker run -i --rm -v $(dirname $PWD):/work/root omegatorg/docgen "$@"
```
...which you can invoke like so:
```shell
docgen -Dlanguage=en html
```
## Build
To support multiple platform architecture like Aarch64/ARM64 and Amd64 such as M1 mac and Windows 11 for ARM,
it should be built as [multi-platform container image](https://docs.docker.com/build/building/multi-platform/).
### Prerequisites:
- Git LFS to checkout jar files under lib/
- Containerd or Docker Engine with QEMU installed
- The container image store enabled
### Build with nerdctl
```shell
echo PassWord | env CLI_CMD=nerdctl USER=myname make login
env CLI_CMD=nerdctl make build
```