From 4f596d3841896f9bdf459e10f0fa639167859b39 Mon Sep 17 00:00:00 2001 From: Iwan Aucamp Date: Fri, 15 Apr 2022 13:55:42 +0200 Subject: [PATCH] build: disable building of epub on readthedocs.org The epub build fails because we have `sphinx.fail_on_warning` set and the epub builder does not know how to handle `html_favicon = "_static/RDFlib.ico"` from `docs/conf.py`, which causes this warning: ``` WARNING: unknown mimetype for _static/RDFlib.ico, ignoring ``` I created an upstream issue for this: https://github.com/sphinx-doc/sphinx/issues/10350 Also: - build: add `.pytest_cache` to `.dockerignore` - mainly because it is quite big and it is not needed when building the test Dockerfile. --- .dockerignore | 1 + .readthedocs.yaml | 8 +++++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/.dockerignore b/.dockerignore index c1024fc56..644d60319 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,4 +1,5 @@ .tox .venv .mypy_cache +.pytest_cache .git diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e19735429..a5a868399 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,7 +1,13 @@ --- # https://docs.readthedocs.io/en/stable/config-file/v2.html version: 2 -formats: all +# NOTE: not builing epub because epub does not know how to handle .ico files +# which results in a warning which causes the build to fail due to +# `sphinx.fail_on_warning` +# https://github.com/sphinx-doc/sphinx/issues/10350 +formats: + - htmlzip + - pdf build: os: ubuntu-20.04