Skip to content

Commit 5679d0f

Browse files
zerokkeimlink
authored andcommitted
Minor fixes for the README.md
I've updated the section about the image variants (and corrected the letter-casing there) as the one for sphinx-doc:latex was a bit too complicated.
1 parent 58d877b commit 5679d0f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ docker run -it -p 8000:8000 --rm -v "$(pwd)/docs":/home/python/docs sphinx-autob
6969

7070
The documentation should served at <http://127.0.0.1:8000>. It will be rebuild when a file is changed.
7171

72-
## Image Variants
72+
## Image variants
7373

7474
The `sphinx-doc` images come in many flavours, each designed for a specific use case.
7575

@@ -85,7 +85,7 @@ This is the defacto image. If you are unsure about what your needs are, you prob
8585

8686
## `sphinx-doc:latex`
8787

88-
This image is based off of [python](https://hub.docker.com/_/python/) and contains all packages needed to build the LaTeX documentation. Because it's based off of [buildpack-deps](https://registry.hub.docker.com/_/buildpack-deps/) and has a large number of extremely common Debian packages.
88+
This image is based off of [python](https://hub.docker.com/_/python/) and contains all packages needed to build the LaTeX documentation. Because the python image is based on [buildpack-deps](https://registry.hub.docker.com/_/buildpack-deps/) and includes large number of common Debian packages the resulting image is much larger than the other variant.
8989

9090
## Code of Conduct
9191

0 commit comments

Comments
 (0)