Skip to content

Commit da3ac4b

Browse files
authored
Incorporate Slang User Guide into readthedocs site (#87)
This replaces the external links to the Slang User Guide in the readthedocs index file with references to the internal copy in the submodule.
1 parent dd1b536 commit da3ac4b

File tree

2 files changed

+5
-8
lines changed

2 files changed

+5
-8
lines changed

docs/conf.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,3 @@ def setup(app):
105105
"color-api-background": "#1e1e1e",
106106
},
107107
}
108-
109-
# Use default Furo sidebar configuration - remove custom sidebar
110-
# html_sidebars = {} # Let Furo use its defaults

docs/index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Slang Documentation
66
:maxdepth: 1
77
:titlesonly:
88

9-
User Guide <https://shader-slang.org/slang/user-guide/>
9+
User Guide <external/slang/docs/user-guide/index>
1010
Standard Modules Reference <external/stdlib-reference/index>
1111
Language Spec <https://github.com/shader-slang/spec>
1212
SlangPy User Guide <external/slangpy/docs/index.rst>
@@ -19,9 +19,9 @@ Slang Documentation
1919
:maxdepth: 1
2020
:titlesonly:
2121

22-
SPIR-V Specific Functionalities <https://shader-slang.org/slang/user-guide/spirv-target-specific.html>
23-
Metal Specific Functionalities <https://shader-slang.org/slang/user-guide/spirv-target-specific.html>
24-
WGSL Specific Functionalities <https://shader-slang.org/slang/user-guide/spirv-target-specific.html>
22+
SPIR-V Specific Functionalities <external/slang/docs/user-guide/a2-01-spirv-target-specific>
23+
Metal Specific Functionalities <external/slang/docs/user-guide/a2-02-metal-target-specific>
24+
WGSL Specific Functionalities <external/slang/docs/user-guide/a2-03-wgsl-target-specific>
2525

2626
.. toctree::
2727
:caption: Tutorials
@@ -30,7 +30,7 @@ Slang Documentation
3030

3131
Write Your First Slang Shader <first-slang-shader>
3232
Using the Compilation API <compilation-api>
33-
Using the Reflection API <https://shader-slang.org/slang/user-guide/reflection.html>
33+
Using the Reflection API <external/slang/docs/user-guide/09-reflection>
3434
Shader Cursors: Advanced Usage of the Reflection API <shader-cursors>
3535
Understanding Slang Generics <understanding-generics>
3636
Migrating from HLSL to Slang <coming-from-hlsl>

0 commit comments

Comments
 (0)