summaryrefslogtreecommitdiffstats
path: root/docs/user-guide
diff options
context:
space:
mode:
authoraidanfnv <aidanf@nvidia.com>2025-05-02 09:02:31 -0700
committerGitHub <noreply@github.com>2025-05-02 09:02:31 -0700
commit87c4ab20abebaf3d2f0e8beb9f71b45eb0b64968 (patch)
treea8e7639e4b528c4b21bd959df6ea7bbf826ba623 /docs/user-guide
parent92fb841a2b738fd5e353b3ad4ea48a1037c69f80 (diff)
Add tables of contents to user guide for use on readthedocs (#6979)
This change adds hidden (commented out) tables of contents to the index of the User Guide, as well as each of the additional chapters, so that readthedocs will render the User Guide structure.
Diffstat (limited to 'docs/user-guide')
-rw-r--r--docs/user-guide/a1-special-topics.md15
-rw-r--r--docs/user-guide/a2-target-specific-features.md11
-rw-r--r--docs/user-guide/a3-reference.md10
-rw-r--r--docs/user-guide/index.md23
4 files changed, 58 insertions, 1 deletions
diff --git a/docs/user-guide/a1-special-topics.md b/docs/user-guide/a1-special-topics.md
index ef218b8fa..f0412b6be 100644
--- a/docs/user-guide/a1-special-topics.md
+++ b/docs/user-guide/a1-special-topics.md
@@ -12,4 +12,17 @@ In this chapter:
2. [Using Slang to write PyTorch kernels](a1-02-slangpy.md)
3. [Obfuscation](a1-03-obfuscation.md)
4. [Interoperation with target-specific code](a1-04-interop.md)
-5. [Uniformity Analysis](a1-05-uniformity.md) \ No newline at end of file
+5. [Uniformity Analysis](a1-05-uniformity.md)
+
+<!-- RTD-TOC-START
+```{toctree}
+:titlesonly:
+:hidden:
+
+Handling Matrix Layout Differences on Different Platforms <a1-01-matrix-layout>
+Using Slang to Write PyTorch Kernels <a1-02-slangpy>
+Obfuscation <a1-03-obfuscation>
+Interoperation with Target-Specific Code <a1-04-interop>
+Uniformity Analysis <a1-05-uniformity>
+```
+RTD-TOC-END --> \ No newline at end of file
diff --git a/docs/user-guide/a2-target-specific-features.md b/docs/user-guide/a2-target-specific-features.md
index e8a85dfff..495148c49 100644
--- a/docs/user-guide/a2-target-specific-features.md
+++ b/docs/user-guide/a2-target-specific-features.md
@@ -11,3 +11,14 @@ In this chapter:
1. [SPIR-V target specific](./a2-01-spirv-target-specific.md)
2. [Metal target specific](./a2-02-metal-target-specific.md)
3. [WGSL target specific](./a2-03-wgsl-target-specific.md)
+
+<!-- RTD-TOC-START
+```{toctree}
+:titlesonly:
+:hidden:
+
+SPIR-V target specific <a2-01-spirv-target-specific>
+Metal target specific <a2-02-metal-target-specific>
+WGSL target specific <a2-03-wgsl-target-specific>
+```
+RTD-TOC-END --> \ No newline at end of file
diff --git a/docs/user-guide/a3-reference.md b/docs/user-guide/a3-reference.md
index db9c445c7..3e2fc836a 100644
--- a/docs/user-guide/a3-reference.md
+++ b/docs/user-guide/a3-reference.md
@@ -9,3 +9,13 @@ Reference
In this chapter:
1. [Reference for all Capability Profiles](a3-01-reference-capability-profiles.md)
2. [Reference for all Capability Atoms](a3-02-reference-capability-atoms.md)
+
+<!-- RTD-TOC-START
+```{toctree}
+:titlesonly:
+:hidden:
+
+Reference for all Capability Profiles <a3-01-reference-capability-profiles>
+Reference for all Capability Atoms <a3-02-reference-capability-atoms>
+```
+RTD-TOC-END --> \ No newline at end of file
diff --git a/docs/user-guide/index.md b/docs/user-guide/index.md
index d57ea1446..a96abd97b 100644
--- a/docs/user-guide/index.md
+++ b/docs/user-guide/index.md
@@ -11,3 +11,26 @@ Welcome to the Slang User's Guide, an introduction to the Slang language, compil
- The reflection API that allows the host application to query the details of shader code in order to generate the right shader kernel and to set shader parameters correctly.
Note: this documentation is still under active development. While the coverage on language features is complete, we are still working on the remaining chapters on Slang's compilation and reflection API.
+
+<!-- RTD-TOC-START
+```{toctree}
+:titlesonly:
+:hidden:
+
+Introduction <00-introduction>
+Getting Started with Slang <01-get-started>
+Conventional Language Features <02-conventional-features>
+Basic Convenience Features <03-convenience-features>
+Modules and Access Control <04-modules-and-access-control>
+Capabilities <05-capabilities>
+Interfaces and Generics <06-interfaces-generics>
+Automatic Differentiation <07-autodiff>
+Compiling Code with Slang <08-compiling>
+Using the Reflection API <09-reflection>
+Supported Compilation Targets <09-targets>
+Link-time Specialization and Module Precompilation <10-link-time-specialization>
+Special Topics <a1-special-topics>
+Target-specific Features <a2-target-specific-features>
+Reference <a3-reference>
+```
+RTD-TOC-END --> \ No newline at end of file