Skip to content

Fix graphs in documentation, update dependencies. #978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hvdijk merged 1 commit into from
Sep 5, 2025
Merged

Fix graphs in documentation, update dependencies. #978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/publish_docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
Expand Down
14 changes: 5 additions & 9 deletions doc/conf.py.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Loading