diff options
| author | aidanfnv <aidanf@nvidia.com> | 2025-05-05 18:19:06 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-05-05 18:19:06 -0700 |
| commit | 480369a302b15749aafc82feb001fa23db8edbd6 (patch) | |
| tree | 8a2ad0326e79560232af3af4a1184f42f718ca8b /docs/user-guide | |
| parent | 0f4a32fccce9106eb00876678fd58a95df62fb5b (diff) | |
Remove extra User Guide readthedocs TOC entries by turning extra H1 headings into H2 (#6986)
readthedocs treats H1 headings as document titles in the sidebar table of contents.
This change turns all extra H1 headings into H2 in the "Metal-Specific Functionalities" doc.
These extra H1 headings seem to be errors, given that they are inconsistent, and the H2s after them do not belong. For examples, the heading "Resource Types" is H2, but "Array Types" is H1, and "Mesh Shader Support" is H1, but the following "Header Inclusions and Namespace" is not a subtopic of the Mesh Shader Support.
Diffstat (limited to 'docs/user-guide')
| -rw-r--r-- | docs/user-guide/a2-02-metal-target-specific.md | 6 | ||||
| -rw-r--r-- | docs/user-guide/toc.html | 3 |
2 files changed, 6 insertions, 3 deletions
diff --git a/docs/user-guide/a2-02-metal-target-specific.md b/docs/user-guide/a2-02-metal-target-specific.md index b14a4889e..8d69a5975 100644 --- a/docs/user-guide/a2-02-metal-target-specific.md +++ b/docs/user-guide/a2-02-metal-target-specific.md @@ -107,7 +107,7 @@ Raster-ordered access resources receive the `[[raster_order_group(0)]]` attribute, for example `texture2d<float, access::read_write> tex [[raster_order_group(0)]]`. -# Array Types +## Array Types Array types in Metal are declared using the array template: @@ -115,7 +115,7 @@ Array types in Metal are declared using the array template: | ------------------- | -------------------------- | | `ElementType[Size]` | `array<ElementType, Size>` | -# Matrix Layout +## Matrix Layout Metal exclusively uses column-major matrix layout. Slang automatically handles the translation of matrix operations to maintain correct semantics: @@ -124,7 +124,7 @@ the translation of matrix operations to maintain correct semantics: - Matrix types are declared as `matrix<T, Columns, Rows>`, for example `float3x4` is represented as `matrix<float, 3, 4>` -# Mesh Shader Support +## Mesh Shader Support Mesh shaders can be targeted using the following types and syntax. The same as task/mesh shaders generally in Slang. diff --git a/docs/user-guide/toc.html b/docs/user-guide/toc.html index b662c278e..13f6e9f03 100644 --- a/docs/user-guide/toc.html +++ b/docs/user-guide/toc.html @@ -217,6 +217,9 @@ <li data-link="metal-target-specific#system-value-semantics"><span>System-Value semantics</span></li> <li data-link="metal-target-specific#interpolation-modifiers"><span>Interpolation Modifiers</span></li> <li data-link="metal-target-specific#resource-types"><span>Resource Types</span></li> +<li data-link="metal-target-specific#array-types"><span>Array Types</span></li> +<li data-link="metal-target-specific#matrix-layout"><span>Matrix Layout</span></li> +<li data-link="metal-target-specific#mesh-shader-support"><span>Mesh Shader Support</span></li> <li data-link="metal-target-specific#header-inclusions-and-namespace"><span>Header Inclusions and Namespace</span></li> <li data-link="metal-target-specific#parameter-blocks-and-argument-buffers"><span>Parameter blocks and Argument Buffers</span></li> <li data-link="metal-target-specific#struct-parameter-flattening"><span>Struct Parameter Flattening</span></li> |