Skip to content

Commit 3bed684

Browse files
Simon RitSimonRit
authored andcommitted
DOC: Add CudaCommon documentation
1 parent 6de3e58 commit 3bed684

File tree

2 files changed

+41
-1
lines changed

2 files changed

+41
-1
lines changed

documentation/docs/copy_and_fetch_sphinx_doc_files.cmake

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,15 @@ set(
1717
"documentation"
1818
)
1919

20+
# List of files to grab from CudaCommon
21+
set(
22+
CUDACOMMONFILES
23+
"README.md"
24+
"cuda_array_interface.md"
25+
"examples/itkCudaArrayInterfaceCupyExample.py"
26+
"examples/itkCudaArrayInterfaceTorchExample.py"
27+
)
28+
2029
# Append the files in the subdirectories
2130
foreach(subdir ${DOCSUBDIRS})
2231
file(
@@ -89,6 +98,21 @@ foreach(content_file ${content_files})
8998
list(APPEND DOCSRCFILES "${content_file_rel_path}")
9099
endforeach()
91100

101+
foreach(cudacommon_file ${CUDACOMMONFILES})
102+
if(NOT EXISTS "${RTK_DOC_OUTPUT_DIR}/${cudacommon_file}")
103+
set(
104+
URL
105+
"https://raw.githubusercontent.com/RTKConsortium/ITKCudaCommon/main/${cudacommon_file}"
106+
)
107+
file(
108+
DOWNLOAD
109+
"${URL}"
110+
"${RTK_DOC_OUTPUT_DIR}/${cudacommon_file}"
111+
)
112+
endif()
113+
list(APPEND DOCSRCFILES "${cudacommon_file}")
114+
endforeach()
115+
92116
# Clean-up: remove all files which are not in the input files or in the _build and documentation/docs/ExternalData/ subfolders
93117
file(
94118
GLOB_RECURSE filesInOutput

index.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,22 @@ RTK is an open-source and cross-platform software for fast circular cone-beam CT
77
[![PyPI](https://img.shields.io/pypi/v/itk-rtk.svg)](https://pypi.python.org/pypi/itk-rtk)
88
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/RTKConsortium/RTK/blob/master/LICENSE.TXT)
99

10+
<br>
11+
1012
```{toctree}
1113
GettingStarted
1214
```
1315

16+
<br>
17+
1418
```{toctree}
1519
:maxdepth: 1
1620
:caption: 💾 Download
1721
INSTALLATION
1822
```
1923

24+
<br>
25+
2026
```{toctree}
2127
:maxdepth: 1
2228
:caption: 📖 Learn
@@ -27,6 +33,17 @@ examples/README.md
2733
applications/README.md
2834
```
2935

36+
<br>
37+
38+
```{toctree}
39+
:maxdepth: 1
40+
:caption: CudaCommon
41+
README.md
42+
cuda_array_interface.md
43+
```
44+
45+
<br>
46+
3047
```{toctree}
3148
:maxdepth: 1
3249
:caption: 🔨 Develop
@@ -37,5 +54,4 @@ documentation/docs/rtk_3_migration_guide.md
3754
CodeContribution
3855
documentation/docs/README
3956
documentation/docs/Release
40-
4157
```

0 commit comments

Comments
 (0)