Skip to content

Commit db5b2c9

Browse files
committed
Fix graphs in documentation, update dependencies.
- Generating graphs needs graphviz to be installed. - A newer versions of Sphinx is needed to support current Python.
1 parent 7c68ac5 commit db5b2c9

3 files changed

Lines changed: 11 additions & 15 deletions

File tree

.github/workflows/publish_docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ jobs:
4141
- name: Install prerequisites
4242
run: |
4343
sudo apt-get update
44-
sudo apt-get install -y doxygen virtualenv
44+
sudo apt-get install -y doxygen graphviz virtualenv
4545
4646
- name: Build OCK documentation
4747
working-directory: ${{github.workspace}}

doc/conf.py.in

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -83,14 +83,14 @@ pygments_style = 'arduino'
8383
extlinks = {
8484
'opencl-1.2':
8585
('https://www.khronos.org/registry/OpenCL/sdk/1.2/docs/man/xhtml/%s.html',
86-
''),
86+
'%s'),
8787
'cmake-command':
88-
('https://cmake.org/cmake/help/latest/command/%s.html', ''),
88+
('https://cmake.org/cmake/help/latest/command/%s.html', '%s'),
8989
'cmake-variable':
90-
('https://cmake.org/cmake/help/latest/variable/%s.html', ''),
90+
('https://cmake.org/cmake/help/latest/variable/%s.html', '%s'),
9191
'spirv':
9292
('https://www.khronos.org/registry/SPIR-V/specs/unified1/SPIRV.html#%s',
93-
''),
93+
'%s'),
9494
}
9595

9696
# If true, `todo` and `todoList` produce output, else they produce nothing.
@@ -148,11 +148,7 @@ html_favicon = '_static/ComputeAorta.ico'
148148
html_static_path = ['_static']
149149

150150
# Additional style sheets for generated HTML.
151-
html_context = {
152-
'css_files': [
153-
'_static/css/theme-override.css',
154-
],
155-
}
151+
html_css_files = ['_static/css/theme-override.css']
156152

157153
# Don't link to the page source in the generated HTML.
158154
html_show_sourcelink = False

doc/requirements.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# Documentation generator.
2-
sphinx==4.5.0
2+
sphinx==6.2.1
33
sphinxcontrib-applehelp==1.0.4
44
sphinxcontrib-devhelp==1.0.2
55
sphinxcontrib-htmlhelp==2.0.1
66
sphinxcontrib-qthelp==1.0.3
77
sphinxcontrib-serializinghtml==1.1.5
88
# Markdown -> Sphinx extension.
9-
myst-parser==0.15.2
9+
myst-parser==0.19.2
1010
linkify-it-py==1.0.2
1111
# Doxygen -> Sphinx extension.
12-
breathe==4.31.0
12+
breathe==4.35.0
1313
# ReadTheDocs theme.
14-
sphinx-rtd-theme==0.5.2
14+
sphinx-rtd-theme==1.2.2
1515
# CMake domain extension.
16-
sphinxcontrib-moderncmakedomain==3.19
16+
sphinxcontrib-moderncmakedomain==3.27.0
1717
# Utilities
1818
sphinx-autobuild==2021.3.14

0 commit comments

Comments
 (0)