From e0dfeb0ce787a87c49121b787fdeee12856cbb2c Mon Sep 17 00:00:00 2001 From: Jorge Marques Date: Mon, 13 Jan 2025 10:42:16 +0100 Subject: [PATCH] docs: Drop wavedrom, reorder requirements Sphinx-wavedrom, cairocffi, CairoSVG don't seem to be tested continuously, which leads to fatal bugs reaching production. The extension in particular has two design oversights: * It renders on the client side, requiring wavedrom.js to be fetched from a different from a different domain, slowing down or even preventing the documentation if the domain is offline (cause of a previous problem). * Even though it renders on the client side in our user case, it still cairo renderer during build, even though it is unused (the root cause of the current issue) Drop it in favor of just committing the wavedrom source (commented out in the page or as a text file in the same path) and the rendered svg. Also, reorder requirements to have adi_doctools as the first requirement. Signed-off-by: Jorge Marques --- docs/conf.py | 1 - docs/requirements.txt | 3 +-- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 478c0dff..54f13384 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -9,7 +9,6 @@ extensions = [ "sphinx.ext.todo", - "sphinxcontrib.wavedrom", "adi_doctools" ] diff --git a/docs/requirements.txt b/docs/requirements.txt index 25985289..f2f07b5c 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,2 @@ -sphinx https://github.com/analogdevicesinc/doctools/releases/download/latest/adi-doctools.tar.gz -sphinxcontrib.wavedrom +sphinx