Skip to content

Commit

Permalink
hack around breathe dependency issue
Browse files Browse the repository at this point in the history
Breathe doesn't fully support sphinx v8 - it raises some warnings
in sphinx since its passing a `str` to Sphinx functions that
expect a `Path`. This still works for now (will be fully removed
in sphinx v9), but is deprecated - which is why breathe
indicates it only support sphinx<=v7.2 in conda.

However, nvidia-sphinx-theme only works with sphinx v8 afaict,
since it is passing a Path to `sphinx.util.fileutil.copy_asset_file`
- which breaks on sphinx v7 since it's expecting a `str`.

Hack around this dependency issue by installing breathe from pip,
which isn't as strict about supported sphinx versions.
  • Loading branch information
benfred committed Dec 16, 2024
1 parent f1be700 commit 822d778
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion conda/environments/all_cuda-118_arch-aarch64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ channels:
- conda-forge
- nvidia
dependencies:
- breathe>=4.35.0
- c-compiler
- clang
- clang-tools=16.0.6
Expand Down Expand Up @@ -57,5 +56,6 @@ dependencies:
- sphinx>=8.0.0
- sysroot_linux-aarch64==2.17
- pip:
- breathe>=4.35.0
- nvidia-sphinx-theme
name: all_cuda-118_arch-aarch64
2 changes: 1 addition & 1 deletion conda/environments/all_cuda-118_arch-x86_64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ channels:
- conda-forge
- nvidia
dependencies:
- breathe>=4.35.0
- c-compiler
- clang
- clang-tools=16.0.6
Expand Down Expand Up @@ -57,5 +56,6 @@ dependencies:
- sphinx>=8.0.0
- sysroot_linux-64==2.17
- pip:
- breathe>=4.35.0
- nvidia-sphinx-theme
name: all_cuda-118_arch-x86_64
2 changes: 1 addition & 1 deletion conda/environments/all_cuda-125_arch-aarch64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ channels:
- conda-forge
- nvidia
dependencies:
- breathe>=4.35.0
- c-compiler
- clang
- clang-tools=16.0.6
Expand Down Expand Up @@ -53,5 +52,6 @@ dependencies:
- sphinx>=8.0.0
- sysroot_linux-aarch64==2.17
- pip:
- breathe>=4.35.0
- nvidia-sphinx-theme
name: all_cuda-125_arch-aarch64
2 changes: 1 addition & 1 deletion conda/environments/all_cuda-125_arch-x86_64.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ channels:
- conda-forge
- nvidia
dependencies:
- breathe>=4.35.0
- c-compiler
- clang
- clang-tools=16.0.6
Expand Down Expand Up @@ -53,5 +52,6 @@ dependencies:
- sphinx>=8.0.0
- sysroot_linux-64==2.17
- pip:
- breathe>=4.35.0
- nvidia-sphinx-theme
name: all_cuda-125_arch-x86_64
2 changes: 1 addition & 1 deletion dependencies.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,6 @@ dependencies:
common:
- output_types: [conda]
packages:
- breathe>=4.35.0
- doxygen>=1.8.20
- graphviz
- ipython
Expand All @@ -405,6 +404,7 @@ dependencies:
- sphinx-markdown-tables
- pip:
- nvidia-sphinx-theme
- breathe>=4.35.0
rust:
common:
- output_types: [conda]
Expand Down

0 comments on commit 822d778

Please sign in to comment.