Skip to content

Commit 94c0211

Browse files
committed
Do not generate Sphinx doc for OpenCL/SPV exts
Do not generate Sphinx documentation for the OpenCL or SPIR-V extensions because they are written in AsciiDoc, which Spinx does not support well. Instead, link to their GitHub location, and readers can read GitHub's rendering of the AsciiDoc documents. This is the same thing we do already for the SYCL extension specifications.
1 parent 0331576 commit 94c0211

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

sycl/doc/conf.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,12 @@
4646
# The suffix of source filenames.
4747
source_suffix = ['.rst', '.md']
4848

49-
# Extensions are mostly in asciidoc which has poor support in Sphinx
50-
exclude_patterns = ['extensions/*']
49+
exclude_patterns = [
50+
# Extensions are mostly in asciidoc which has poor support in Sphinx.
51+
'extensions/*',
52+
'design/opencl-extensions/*',
53+
'design/spirv-extensions/*'
54+
]
5155

5256
suppress_warnings = [ 'misc.highlighting_failure' ]
5357

sycl/doc/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ Developing oneAPI DPC++ Compiler
4242
ITTAnnotations
4343
DeviceGlobal
4444
CompileTimeProperties
45+
New OpenCL Extensions <https://github.com/intel/llvm/tree/sycl/sycl/doc/design/opencl-extensions>
46+
New SPIR-V Extensions <https://github.com/intel/llvm/tree/sycl/sycl/doc/design/spirv-extensions>
4547

4648
Development BKMs
4749
~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)