mirror of
https://github.com/ldericher/autodoc.git
synced 2025-12-06 15:43:01 +00:00
Merge branch 'release/0.6.0'
This commit is contained in:
commit
ebabff7725
10 changed files with 56 additions and 32 deletions
|
|
@ -7,8 +7,6 @@ steps:
|
||||||
image: plugins/docker
|
image: plugins/docker
|
||||||
settings:
|
settings:
|
||||||
repo: ldericher/autodoc
|
repo: ldericher/autodoc
|
||||||
context: src
|
|
||||||
dockerfile: src/Dockerfile
|
|
||||||
auto_tag: true
|
auto_tag: true
|
||||||
username:
|
username:
|
||||||
from_secret: DOCKER_USERNAME
|
from_secret: DOCKER_USERNAME
|
||||||
|
|
|
||||||
15
Dockerfile
Normal file
15
Dockerfile
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
FROM pandoc/extra:latest
|
||||||
|
|
||||||
|
RUN set -ex; \
|
||||||
|
\
|
||||||
|
apk add --no-cache \
|
||||||
|
bash \
|
||||||
|
inotify-tools \
|
||||||
|
make \
|
||||||
|
;
|
||||||
|
|
||||||
|
COPY src/usr /usr
|
||||||
|
|
||||||
|
WORKDIR /docs
|
||||||
|
ENTRYPOINT ["autodoc"]
|
||||||
|
CMD ["-bw"]
|
||||||
28
Makefile
Normal file
28
Makefile
Normal file
|
|
@ -0,0 +1,28 @@
|
||||||
|
image_tag = ldericher/autodoc
|
||||||
|
docker_build = docker build
|
||||||
|
docker_run = docker run --rm -it
|
||||||
|
examples_flags = -v "$(shell pwd)/examples:/docs" -u "$(shell id -u):$(shell id -g)"
|
||||||
|
|
||||||
|
.PHONY: default
|
||||||
|
default:
|
||||||
|
$(info use other targets: image build watch shell clean)
|
||||||
|
|
||||||
|
.PHONY: image
|
||||||
|
image:
|
||||||
|
$(docker_build) --tag $(image_tag) ./
|
||||||
|
|
||||||
|
.PHONY: build
|
||||||
|
build: image
|
||||||
|
$(docker_run) $(examples_flags) $(image_tag) -b
|
||||||
|
|
||||||
|
.PHONY: watch
|
||||||
|
watch: image
|
||||||
|
$(docker_run) $(examples_flags) $(image_tag)
|
||||||
|
|
||||||
|
.PHONY: shell
|
||||||
|
shell: image
|
||||||
|
$(docker_run) $(examples_flags) --entrypoint ash $(image_tag)
|
||||||
|
|
||||||
|
.PHONY: clean
|
||||||
|
clean:
|
||||||
|
git clean -xdf ./examples
|
||||||
|
|
@ -8,7 +8,7 @@ In general, any file-sharing solution -- preferably on top of `docker-compose` -
|
||||||
|
|
||||||
## Quick Start Guide using Docker
|
## Quick Start Guide using Docker
|
||||||
|
|
||||||
The `autodoc` image [available on Docker Hub](https://hub.docker.com/r/ldericher/autodoc) is based on [pandocker](https://hub.docker.com/r/ldericher/pandocker) providing Ubuntu's TeXlive `LaTeX` and `pandoc` in a simple box.
|
The `autodoc` image [available on Docker Hub](https://hub.docker.com/r/ldericher/autodoc) is based on [pandoc/extra](https://hub.docker.com/r/pandoc/extra) providing TeXlive `LaTeX` and `pandoc` in a container.
|
||||||
|
|
||||||
01. Install [Docker CE](https://docs.docker.com/install/)
|
01. Install [Docker CE](https://docs.docker.com/install/)
|
||||||
|
|
||||||
|
|
@ -18,7 +18,7 @@ The `autodoc` image [available on Docker Hub](https://hub.docker.com/r/ldericher
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker run --rm -it \
|
docker run --rm -it \
|
||||||
--volume "${PWD}":/docs \
|
--volume "${PWD}:/docs" \
|
||||||
--user "$(id -u):$(id -g)" \
|
--user "$(id -u):$(id -g)" \
|
||||||
ldericher/autodoc
|
ldericher/autodoc
|
||||||
```
|
```
|
||||||
|
|
@ -58,7 +58,6 @@ services:
|
||||||
- documents:/opt/autodoc
|
- documents:/opt/autodoc
|
||||||
|
|
||||||
autodoc:
|
autodoc:
|
||||||
restart: always
|
|
||||||
image: ldericher/autodoc
|
image: ldericher/autodoc
|
||||||
user: "UID:GID"
|
user: "UID:GID"
|
||||||
volumes:
|
volumes:
|
||||||
|
|
|
||||||
|
|
@ -1,16 +0,0 @@
|
||||||
version: "2"
|
|
||||||
|
|
||||||
services:
|
|
||||||
autodoc:
|
|
||||||
restart: "no"
|
|
||||||
|
|
||||||
image: ldericher/autodoc
|
|
||||||
build:
|
|
||||||
context: ./src
|
|
||||||
|
|
||||||
command: "bash"
|
|
||||||
|
|
||||||
volumes:
|
|
||||||
- "${PWD}/src/usr/local/bin/autodoc:/usr/local/bin/autodoc:ro"
|
|
||||||
- "${PWD}/src/usr/local/lib/autodoc:/usr/local/lib/autodoc:ro"
|
|
||||||
- "${PWD}/examples:/docs"
|
|
||||||
1
examples/eisvogel/.gitignore
vendored
Normal file
1
examples/eisvogel/.gitignore
vendored
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
*.pdf
|
||||||
8
examples/eisvogel/Makefile
Normal file
8
examples/eisvogel/Makefile
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
#%SRCPAT% \.url$
|
||||||
|
|
||||||
|
.PHONY: all
|
||||||
|
all: eisvogel.pdf
|
||||||
|
|
||||||
|
.PHONY: eisvogel.pdf
|
||||||
|
eisvogel.pdf: document.md.url
|
||||||
|
wget -O- '$(file < $<)' | pandoc -s -f markdown -t latex -o $@ --template eisvogel
|
||||||
1
examples/eisvogel/document.md.url
Normal file
1
examples/eisvogel/document.md.url
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
https://raw.githubusercontent.com/Wandmalfarbe/pandoc-latex-template/master/examples/basic-example/document.md
|
||||||
|
|
@ -15,7 +15,7 @@ Behold, for there is jumbled mess ahead!
|
||||||
|
|
||||||
With the default HTML template, this does not translate: \textsl{Have some \LaTeX, too!}
|
With the default HTML template, this does not translate: \textsl{Have some \LaTeX, too!}
|
||||||
Some math is fine with HTML: $x=5$, some other is not: $\sqrt{x}=2$.
|
Some math is fine with HTML: $x=5$, some other is not: $\sqrt{x}=2$.
|
||||||
However, both of these are fixable!
|
However, both of these work with the `--webtex` switch for pandoc!
|
||||||
|
|
||||||
Code blocks? Sure!
|
Code blocks? Sure!
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,10 +0,0 @@
|
||||||
FROM ldericher/pandocker:latest
|
|
||||||
|
|
||||||
RUN set -ex; \
|
|
||||||
apt-get update && apt-get -y install \
|
|
||||||
inotify-tools \
|
|
||||||
; rm -rf /var/lib/apt/lists/*;
|
|
||||||
|
|
||||||
COPY usr /usr
|
|
||||||
|
|
||||||
CMD ["autodoc", "-bw"]
|
|
||||||
Loading…
Reference in a new issue