Skip to content

Incorporate Slang User Guide into readthedocs site #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aidanfnv merged 5 commits into from
May 2, 2025
Merged

Incorporate Slang User Guide into readthedocs site #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
956d4e3
Integrate user guide into RTD site
aidanfnv May 2, 2025
a348d9e
Update stdlib submodule
aidanfnv May 2, 2025
80515f2
Add explicit include patterns for Sphinx
aidanfnv May 2, 2025
c8f619e
Undo theme change
aidanfnv May 2, 2025
df77fcd
Merge branch 'main' into fix/readthedocs-user-guide
aidanfnv May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,3 @@ def setup(app):
"color-api-background": "#1e1e1e",
},
}

# Use default Furo sidebar configuration - remove custom sidebar
# html_sidebars = {} # Let Furo use its defaults
10 changes: 5 additions & 5 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Slang Documentation
:maxdepth: 1
:titlesonly:

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

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

.. toctree::
:caption: Tutorials
Expand All @@ -30,7 +30,7 @@ Slang Documentation

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