taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

commit c6f51692fcdddd780becc604727636ef0687aaf5
parent 72f80d08eb707beee2c1e682b7b8f5ee5539f89a
Author: Özgür Kesim <oec-taler@kesim.org>
Date:   Sun,  3 Nov 2024 14:11:04 +0100

workaround for incorrect href's for generated math-images

Diffstat:
Mconf.py | 3++-
Mcontrib/ci/Containerfile | 2++
Mcontrib/ci/jobs/0-build/build-docs.sh | 10++++++++++
3 files changed, 14 insertions(+), 1 deletion(-)

diff --git a/conf.py b/conf.py @@ -62,7 +62,8 @@ extensions = [ "sphinx.ext.graphviz", ] -imgmath_embed = True +imgmath_image_format = 'svg' +imgmath_use_preview = True # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/contrib/ci/Containerfile b/contrib/ci/Containerfile @@ -14,6 +14,8 @@ RUN apt-get update -yqq && \ texlive-latex-extra \ texlive-fonts-recommended \ tex-gyre \ + dvipng \ + dvisvgm \ latexmk \ && rm -rf /var/lib/apt/lists/* diff --git a/contrib/ci/jobs/0-build/build-docs.sh b/contrib/ci/jobs/0-build/build-docs.sh @@ -15,4 +15,14 @@ if [[ ${CI_GIT_BRANCH} = "master" ]]; then cp -r _build/html/* "${ARTIFACTS_DIR}/docs_build/docs/html/" cp -r _build/latex/*.pdf "${ARTIFACTS_DIR}/docs_build/docs/pdf/" + + # [oec 20241103] BUG,TODO + # + # For some reason unknown, the links to the generated images from the + # embedded LaTeX :math:`...` statements are wrong on docs.taler.net: + # The href's SHOULD be pointing to `../images/_math`, but instead they + # point to `images/_math` (i.e. relative to a dir like `design-documents/`). + # + # Here is a workaround for this issue, at least for `design-documents/`: + ln -s ../images "${ARTIFACTS_DIR}/docs_build/docs/html/design_documents/images" fi