Skip to content

Commit 37f94ad

Browse files
authored
Change links on docs page to go to readthedocs (#99)
Fixes #94 The Slang docs will now be located at https://docs.shader-slang.org on ReadTheDocs. This change updates the links on https://shader-slang.org/docs/ to go to the relevant sections/pages of the RTD site instead of the GitHub Pages docs sites.
1 parent 9ba5f56 commit 37f94ad

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

_data/documentation.yaml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,77 @@
11
overview:
22
- title: "User Guide"
33
description: "The guide provides an introduction to the Slang language and its major features, as well as the compilation and reflection API."
4-
link_url: "https://shader-slang.com/slang/user-guide/"
4+
link_url: "https://docs.shader-slang.org/en/latest/external/slang/docs/user-guide/"
55
link_label: "User Guide"
66
- title: "Standard Modules Reference"
77
description: "The reference of the standard modules that comes with the Slang compiler."
8-
link_url: "https://shader-slang.com/stdlib-reference/"
8+
link_url: "https://docs.shader-slang.org/en/latest/external/stdlib-reference/"
99
link_label: "Modules Reference"
1010
- title: "Language Specification"
1111
description: "The formal specification of the Slang programming language. Work in progress.."
1212
link_url: "https://github.com/shader-slang/spec"
1313
link_label: "Language Specification"
1414
- title: "SlangPy User Guide"
1515
description: "Learn how to build machine learning and neural graphics applications with Slang and Python."
16-
link_url: "https://slangpy.shader-slang.org"
16+
link_url: "https://docs.shader-slang.org/en/latest/external/slangpy/docs/"
1717
link_label: "SlangPy User Guide"
1818
- title: "Feature Matureness"
1919
description: "List of Slang Features with their stableness/matureness."
20-
link_url: "https://shader-slang.com/docs/feature_matureness"
20+
link_url: "https://docs.shader-slang.org/en/latest/feature_matureness.html"
2121
link_label: "Feature matureness"
2222
- title: "Command Line Reference"
2323
description: "There is the documentation specific to using the slangc command-line tool."
2424
link_url: "https://github.com/shader-slang/slang/blob/master/docs/command-line-slangc-reference.md"
2525
link_label: "Command Line Reference"
2626
- title: "Frequently Asked Questions"
2727
description: "Answers to a list of frequently asked questions."
28-
link_url: "https://shader-slang.com/docs/faq"
28+
link_url: "https://docs.shader-slang.org/en/latest/faq.html"
2929
link_label: "Slang FAQ"
3030

3131
articles:
3232
- title: "SPIR-V Specific Functionalities"
3333
description: "Things to know when using Slang to compile to SPIR-V."
34-
link_url: "https://shader-slang.com/slang/user-guide/spirv-target-specific.html"
34+
link_url: "https://docs.shader-slang.org/en/latest/external/slang/docs/user-guide/a2-01-spirv-target-specific.html"
3535
link_label: "SPIR-V Specifics"
3636
- title: "Metal Specific Functionalities"
3737
description: "Things to know when using Slang to compile to the Metal Shading Language."
38-
link_url: "https://shader-slang.com/slang/user-guide/metal-target-specific"
38+
link_url: "https://docs.shader-slang.org/en/latest/external/slang/docs/user-guide/a2-02-metal-target-specific.html"
3939
link_label: "Metal Functionalities"
4040
- title: "WGSL Specific Functionalities"
4141
description: "Things to know when using Slang to compile to the WGSL."
42-
link_url: "https://shader-slang.com/slang/user-guide/wgsl-target-specific"
42+
link_url: "https://docs.shader-slang.org/en/latest/external/slang/docs/user-guide/a2-03-wgsl-target-specific.html"
4343
link_label: "WGSL Functionalities"
4444

4545
tutorials:
4646
- title: "Write Your First Slang Shader"
4747
description: "See how to write a simple compute shader in Slang and compile it for execution on Vulkan."
48-
link_url: "https://shader-slang.com/docs/first-slang-shader"
48+
link_url: "https://docs.shader-slang.org/en/latest/first-slang-shader.html"
4949
link_label: "My First Shader"
5050
- title: "Using the Compilation API"
5151
description: "See how to use Slang’s compilation API to integrate the Slang compiler into your application."
52-
link_url: "https://shader-slang.com/docs/compilation-api"
52+
link_url: "https://docs.shader-slang.org/en/latest/compilation-api.html"
5353
link_label: "The Compilation API"
5454
- title: "Using the Reflection API"
5555
description: "See how to use Slang’s reflection API to query for parameter binding info at runtime."
56-
link_url: "https://shader-slang.com/slang/user-guide/reflection"
56+
link_url: "https://docs.shader-slang.org/en/latest/external/slang/docs/user-guide/09-reflection.html"
5757
link_label: "The Reflection API"
5858
- title: "Shader Cursors: Advanced Usage of the Reflection API"
5959
description: "Learn how to handle shader parameters in a practical and high-performance fashion that can scale to support large GPU shader codebases across multiple target platforms"
60-
link_url: "https://shader-slang.com/docs/shader-cursors"
60+
link_url: "https://docs.shader-slang.org/en/latest/shader-cursors.html"
6161
link_label: "Shader Cursors"
6262
- title: "Understanding Slang Generics"
6363
description: "Learn how to use Slang’s generics and interfaces to write structured code that can be specialized at compile time."
64-
link_url: "/docs/understanding-generics"
64+
link_url: "https://docs.shader-slang.org/en/latest/understanding-generics.html"
6565
link_label: "Slang Generics"
6666
- title: "Migrating from HLSL to Slang"
6767
description: "Main things to know if you are coming to Slang as an HLSL developer."
68-
link_url: "/docs/coming-from-hlsl/"
68+
link_url: "https://docs.shader-slang.org/en/latest/coming-from-hlsl.html"
6969
link_label: "Coming from HLSL"
7070
- title: "Using Slang Parameter Blocks"
7171
description: "Learn how to use Slang’s Parameter Block feature in your shader codebase, and how to streamline use of the Slang reflection API when using this feature."
72-
link_url: "/docs/parameter-blocks/"
72+
link_url: "https://docs.shader-slang.org/en/latest/parameter-blocks.html"
7373
link_label: "Using Slang Parameter Blocks"
7474
- title: "Migrating from GLSL to Slang"
7575
description: "Main things to know if you are coming to Slang as an GLSL developer."
76-
link_url: "/docs/coming-from-glsl/"
76+
link_url: "https://docs.shader-slang.org/en/latest/coming-from-glsl.html"
7777
link_label: "Coming from GLSL"

0 commit comments

Comments
 (0)