Skip to content

Commit 4efb3b5

Browse files
committed
Update changelog, add build instructions
1 parent 923c100 commit 4efb3b5

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,23 @@
11
# Docker images for building Tarantool documentation
22

3+
## Contributing
4+
5+
### Building the image locally
6+
7+
Default (fat) image:
8+
```bash
9+
docker build -t tarantool/doc-builder:fat-tag .
10+
```
11+
12+
Slim image
13+
```bash
14+
docker build -t tarantool/doc-builder:slim-4.1 --file Dockerfile-slim .
15+
```
16+
### Releasing the image
17+
18+
Put an annotated tag on the commit after merging your PR.
19+
CI will build and publish it to Docker Hub.
20+
321
## Getting started
422

523
Pull the docker image
@@ -31,9 +49,14 @@ docker run --rm -it -v $(pwd):/doc tarantool/doc-builder sh -c "make <doc>"
3149
- awscli
3250
- pandoc
3351
- panflute
52+
- dvisvgm
3453

3554
## Version history
3655

56+
### 4.1
57+
58+
* Add dvisvgm package for buinding SVGs with math formulas.
59+
3760
### 4.0
3861

3962
* Sphinx updated to 4.3.1

0 commit comments

Comments
 (0)