GNUBoot
/
coreboot-kgpe-d16
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
coreboot-kgpe-d16/util/docker/doc.coreboot.org/Dockerfile

30 lines
818 B
Docker
Raw Normal View History

util/docker: Update Dockerfiles for building the documentation The doc.coreboot.org container is several years out of date, using the three year old Alpine 3.8 as the base image along with Sphinx related pip packages which are even older. Accordingly, update the documentation related pip packages in the coreboot-jenkins-node container as well. - Update doc.coreboot.org to Alpine 3.18.3 - Update documentation related pip packages on coreboot-jenkins-node and doc.coreboot.org to the latest versions on PyPI - Update Sphinx to 6.2.1 as the latest version of sphinx_rtd_theme does not yet support sphinx >= 7 The updates also noticeably improve performance, dropping documentation build times from ~75 s down to ~42 s on my system from the Alpine+Python updates alone, and further down to ~35 s with the rest of the updates. TEST: The documentation builds and renders properly when built using the updated container. Change-Id: I38dfd22ee71c3779ab5fd3b3060e4675e9e3fe54 Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/73159 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Reviewed-by: Martin L Roth <gaumless@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2023-02-22 19:55:22 +01:00
FROM alpine:3.18.3
util/docker/doc.coreboot.org/Dockerfile: Use alpine:3.8, Sphinx 1.7 With Alpine base, use pip to install Sphinx 1.7 and Sphinx-autobuild Alpine, a 4.5MB base, is used over Debian Stable, 101MB, to cut down the total size of the docker image. Change-Id: I53f246206458b1de34cd7f3a42481b91ca285ff0 Signed-off-by: Tom Hiller <thrilleratplay@gmail.com> Reviewed-on: https://review.coreboot.org/28211 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Georgi <pgeorgi@google.com>
2018-08-19 01:39:55 +02:00
COPY makeSphinx.sh /makeSphinx.sh
util/docker: Update Dockerfiles for building the documentation The doc.coreboot.org container is several years out of date, using the three year old Alpine 3.8 as the base image along with Sphinx related pip packages which are even older. Accordingly, update the documentation related pip packages in the coreboot-jenkins-node container as well. - Update doc.coreboot.org to Alpine 3.18.3 - Update documentation related pip packages on coreboot-jenkins-node and doc.coreboot.org to the latest versions on PyPI - Update Sphinx to 6.2.1 as the latest version of sphinx_rtd_theme does not yet support sphinx >= 7 The updates also noticeably improve performance, dropping documentation build times from ~75 s down to ~42 s on my system from the Alpine+Python updates alone, and further down to ~35 s with the rest of the updates. TEST: The documentation builds and renders properly when built using the updated container. Change-Id: I38dfd22ee71c3779ab5fd3b3060e4675e9e3fe54 Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/73159 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Reviewed-by: Martin L Roth <gaumless@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2023-02-22 19:55:22 +01:00
RUN apk add --no-cache python3 py3-pip make bash git openjdk8-jre ttf-dejavu fontconfig \
util/docker/doc.coreboot.org/Dockerfile: Use alpine:3.8, Sphinx 1.7 With Alpine base, use pip to install Sphinx 1.7 and Sphinx-autobuild Alpine, a 4.5MB base, is used over Debian Stable, 101MB, to cut down the total size of the docker image. Change-Id: I53f246206458b1de34cd7f3a42481b91ca285ff0 Signed-off-by: Tom Hiller <thrilleratplay@gmail.com> Reviewed-on: https://review.coreboot.org/28211 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Georgi <pgeorgi@google.com>
2018-08-19 01:39:55 +02:00
&& pip3 install --upgrade --no-cache-dir pip \
&& pip3 install --no-cache-dir \
util/docker: Update Dockerfiles for building the documentation The doc.coreboot.org container is several years out of date, using the three year old Alpine 3.8 as the base image along with Sphinx related pip packages which are even older. Accordingly, update the documentation related pip packages in the coreboot-jenkins-node container as well. - Update doc.coreboot.org to Alpine 3.18.3 - Update documentation related pip packages on coreboot-jenkins-node and doc.coreboot.org to the latest versions on PyPI - Update Sphinx to 6.2.1 as the latest version of sphinx_rtd_theme does not yet support sphinx >= 7 The updates also noticeably improve performance, dropping documentation build times from ~75 s down to ~42 s on my system from the Alpine+Python updates alone, and further down to ~35 s with the rest of the updates. TEST: The documentation builds and renders properly when built using the updated container. Change-Id: I38dfd22ee71c3779ab5fd3b3060e4675e9e3fe54 Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/73159 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Reviewed-by: Martin L Roth <gaumless@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2023-02-22 19:55:22 +01:00
jinja2==3.1.2 \
recommonmark===0.7.1\
sphinx===6.2.1 \
sphinxcontrib-ditaa===1.0.2 \
sphinx_autobuild===2021.3.14 \
sphinx_rtd_theme===1.2.2 \
util/docker/doc.coreboot.org/Dockerfile: Use alpine:3.8, Sphinx 1.7 With Alpine base, use pip to install Sphinx 1.7 and Sphinx-autobuild Alpine, a 4.5MB base, is used over Debian Stable, 101MB, to cut down the total size of the docker image. Change-Id: I53f246206458b1de34cd7f3a42481b91ca285ff0 Signed-off-by: Tom Hiller <thrilleratplay@gmail.com> Reviewed-on: https://review.coreboot.org/28211 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Georgi <pgeorgi@google.com>
2018-08-19 01:39:55 +02:00
&& chmod 755 /makeSphinx.sh
util/docker: Update dockerfiles - Remove deprecated "MAINTAINER" lines - Add Sphinx tools to coreboot-jenkins-node to check documentation. - Add mdl to check markdown - Alphabetize packages in docs Dockerfile - Add jinja2 version 3.0.3 to the docs Dockerfile - The latest version breaks with the error: "exception: cannot import name 'contextfunction' from 'jinja2'" Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: Ia1de62621a6aef4ecd055a1a3afbebad34448002 Reviewed-on: https://review.coreboot.org/c/coreboot/+/64655 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <felixsinger@posteo.net>
2022-05-24 00:04:38 +02:00
util/docker: Update Dockerfiles for building the documentation The doc.coreboot.org container is several years out of date, using the three year old Alpine 3.8 as the base image along with Sphinx related pip packages which are even older. Accordingly, update the documentation related pip packages in the coreboot-jenkins-node container as well. - Update doc.coreboot.org to Alpine 3.18.3 - Update documentation related pip packages on coreboot-jenkins-node and doc.coreboot.org to the latest versions on PyPI - Update Sphinx to 6.2.1 as the latest version of sphinx_rtd_theme does not yet support sphinx >= 7 The updates also noticeably improve performance, dropping documentation build times from ~75 s down to ~42 s on my system from the Alpine+Python updates alone, and further down to ~35 s with the rest of the updates. TEST: The documentation builds and renders properly when built using the updated container. Change-Id: I38dfd22ee71c3779ab5fd3b3060e4675e9e3fe54 Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/73159 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Reviewed-by: Martin L Roth <gaumless@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2023-02-22 19:55:22 +01:00
ADD https://github.com/stathissideris/ditaa/releases/download/v0.11.0/ditaa-0.11.0-standalone.jar \
/usr/lib/ditaa-0.11.0-standalone.jar
Documentation: enable ditaa integration For prettier diagrams: http://ditaa.sourceforge.net/ Change-Id: Ic28dc5ea9d82ff6bf8654e2e33e675a536348654 Signed-off-by: Patrick Georgi <pgeorgi@google.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/37646 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net> Reviewed-by: Angel Pons <th3fanbus@gmail.com>
2019-12-10 20:27:38 +01:00
ADD ditaa.sh /usr/bin/ditaa
util/docker/doc.coreboot.org/Dockerfile: Use alpine:3.8, Sphinx 1.7 With Alpine base, use pip to install Sphinx 1.7 and Sphinx-autobuild Alpine, a 4.5MB base, is used over Debian Stable, 101MB, to cut down the total size of the docker image. Change-Id: I53f246206458b1de34cd7f3a42481b91ca285ff0 Signed-off-by: Tom Hiller <thrilleratplay@gmail.com> Reviewed-on: https://review.coreboot.org/28211 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Georgi <pgeorgi@google.com>
2018-08-19 01:39:55 +02:00
util/docker: Add docker container that builds the sphinx documentation It's what we use on coreboot.org to update www.coreboot.org/Documentation Change-Id: I6e5457d2e39a10f14fabd68bbb231a05e2f66f1d Signed-off-by: Patrick Georgi <patrick@georgi.software> Reviewed-on: https://review.coreboot.org/25869 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com> Reviewed-by: Martin Roth <martinroth@google.com> Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
2018-04-26 14:29:20 +02:00
VOLUME /data-in /data-out
util/docker/doc.coreboot.org/Dockerfile: Use alpine:3.8, Sphinx 1.7 With Alpine base, use pip to install Sphinx 1.7 and Sphinx-autobuild Alpine, a 4.5MB base, is used over Debian Stable, 101MB, to cut down the total size of the docker image. Change-Id: I53f246206458b1de34cd7f3a42481b91ca285ff0 Signed-off-by: Tom Hiller <thrilleratplay@gmail.com> Reviewed-on: https://review.coreboot.org/28211 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Georgi <pgeorgi@google.com>
2018-08-19 01:39:55 +02:00
# For Sphinx-autobuild
# Port 8000 - HTTP server
# Port 35729 - websockets connection to allow automatic browser reloads after each build
EXPOSE 8000 35729
ENTRYPOINT ["/bin/bash", "/makeSphinx.sh"]
CMD []