From db5b2c9abea0e1b30510f32fce990670c941b3d8 Mon Sep 17 00:00:00 2001 From: Harald van Dijk Date: Fri, 5 Sep 2025 16:15:29 +0100 Subject: [PATCH] Fix graphs in documentation, update dependencies. - Generating graphs needs graphviz to be installed. - A newer versions of Sphinx is needed to support current Python. --- .github/workflows/publish_docs.yml | 2 +- doc/conf.py.in | 14 +++++--------- doc/requirements.txt | 10 +++++----- 3 files changed, 11 insertions(+), 15 deletions(-) diff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.yml index 174315d33e..6449c4642b 100644 --- a/.github/workflows/publish_docs.yml +++ b/.github/workflows/publish_docs.yml @@ -41,7 +41,7 @@ jobs: - name: Install prerequisites run: | sudo apt-get update - sudo apt-get install -y doxygen virtualenv + sudo apt-get install -y doxygen graphviz virtualenv - name: Build OCK documentation working-directory: ${{github.workspace}} diff --git a/doc/conf.py.in b/doc/conf.py.in index d240069ae7..b6f9d09126 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -83,14 +83,14 @@ pygments_style = 'arduino' extlinks = { 'opencl-1.2': ('https://www.khronos.org/registry/OpenCL/sdk/1.2/docs/man/xhtml/%s.html', - ''), + '%s'), 'cmake-command': - ('https://cmake.org/cmake/help/latest/command/%s.html', ''), + ('https://cmake.org/cmake/help/latest/command/%s.html', '%s'), 'cmake-variable': - ('https://cmake.org/cmake/help/latest/variable/%s.html', ''), + ('https://cmake.org/cmake/help/latest/variable/%s.html', '%s'), 'spirv': ('https://www.khronos.org/registry/SPIR-V/specs/unified1/SPIRV.html#%s', - ''), + '%s'), } # If true, `todo` and `todoList` produce output, else they produce nothing. @@ -148,11 +148,7 @@ html_favicon = '_static/ComputeAorta.ico' html_static_path = ['_static'] # Additional style sheets for generated HTML. -html_context = { - 'css_files': [ - '_static/css/theme-override.css', - ], -} +html_css_files = ['_static/css/theme-override.css'] # Don't link to the page source in the generated HTML. html_show_sourcelink = False diff --git a/doc/requirements.txt b/doc/requirements.txt index a286e5a72a..26eb078091 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,18 +1,18 @@ # Documentation generator. -sphinx==4.5.0 +sphinx==6.2.1 sphinxcontrib-applehelp==1.0.4 sphinxcontrib-devhelp==1.0.2 sphinxcontrib-htmlhelp==2.0.1 sphinxcontrib-qthelp==1.0.3 sphinxcontrib-serializinghtml==1.1.5 # Markdown -> Sphinx extension. -myst-parser==0.15.2 +myst-parser==0.19.2 linkify-it-py==1.0.2 # Doxygen -> Sphinx extension. -breathe==4.31.0 +breathe==4.35.0 # ReadTheDocs theme. -sphinx-rtd-theme==0.5.2 +sphinx-rtd-theme==1.2.2 # CMake domain extension. -sphinxcontrib-moderncmakedomain==3.19 +sphinxcontrib-moderncmakedomain==3.27.0 # Utilities sphinx-autobuild==2021.3.14