summaryrefslogtreecommitdiffstats
path: root/docs/user-guide/index.md
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/index.md
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/index.md')
-rw-r--r--docs/user-guide/index.md23
1 files changed, 23 insertions, 0 deletions
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