summaryrefslogtreecommitdiff
path: root/docs/user-guide/toc.html
AgeCommit message (Collapse)Author
2025-05-05Remove extra User Guide readthedocs TOC entries by turning extra H1 headings ↵aidanfnv
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.
2025-04-11Fix user-guide typos (#6789)Gangzheng Tong
* Fix user-guide typos Use LLM to scan each of the markdown files to fix typos. Try not to change anything but the typos in this CL. * typo not caught by LLM * add output of ./build_toc.ps1
2025-03-05Add module organization suggestion doc (#6509)cheneym2
* Add module organization suggestion doc Suggest one method to keep slang modules organized in the file system. Closes #4841
2025-02-06Mark slangpy as deprecated and remove from user-guide. (#6300)Yong He
2025-01-30[Docs] Auto-diff documentation overhaul (#6202)Sai Praveen Bangaru
* AD: Docs Update * More documentation * More documentation * More docs fixes * Cleanup documentation * More docs polish. Add docs for the [Differentiable] attributes * Fixup code sections * Fixup * Address review comments * regenerate documentation Table of Contents * Update docs with more playground links --------- Co-authored-by: slangbot <186143334+slangbot@users.noreply.github.com> Co-authored-by: Yong He <yonghe@outlook.com>
2025-01-10Initial implementation of SP#015 `DescriptorHandle<T>`. (#6028)Yong He
* Initial implementation of `ResourcePtr<T>`. * Update docs * Fix build error. * Add more discussion. * Update documentation. * Update TOC. * Fix. * Fix. * Add test case for custom `getResourceFromBindlessHandle`. * Add namehint to generated descriptor heap param. * Fix. * Fix. * format code * Rename to `DescriptorHandle`, and add `T.Handle` alias. * Fix compiler error. * Fix. * Fix build. * Renames. * Fix documentation. * Documentation fix. --------- Co-authored-by: slangbot <186143334+slangbot@users.noreply.github.com>
2024-12-13Update reflection API chapter in User Guide (#5868)Theresa Foley
* Update reflection API chapter in User guide The new version of the chapter is intended to accompany the `reflection-api` example program, and reflects (pun intended) the best practices that the Slang project team wants to encourage for interacting with the reflection API. * Rebuild TOCs
2024-12-06Support specialization constant on WGSL and Metal. (#5780)Yong He
2024-12-06Implement explciit binding for metal and wgsl. (#5778)Yong He
* Respect explicit bindings in wgsl emit. * Implement explciit binding generation for metal and wgsl. * Update toc. * Fix warnings in tests. * Fix tests. --------- Co-authored-by: Ellie Hermaszewska <ellieh@nvidia.com>
2024-12-02[Docs] Fix dead links when subsection title have underscore (#5662)Ica
* [Docs] Fix dead links when subsection title have underscore a minor change on build toc script: add underscore to link instead of replacing with "-" then I re-run the script also I tested on local server * Update toc.html --------- Co-authored-by: Ellie Hermaszewska <ellieh@nvidia.com> Co-authored-by: Yong He <yonghe@outlook.com>
2024-12-02Add WebGPU target doc (#5708)Anders Leino
* Add WebGPU target doc This closes #5698. * Update ToC
2024-11-29docs: Reduce typo count (#5671)Bruce Mitchener
Co-authored-by: Ellie Hermaszewska <ellieh@nvidia.com>
2024-11-25[Docs] Re-run build_toc and fix dead links (#5647)Ica
* re-run build_toc.ps1 * fix dead link of readme --------- Co-authored-by: Ellie Hermaszewska <ellieh@nvidia.com>
2024-11-22[Docs] fix spirv dead links on toc.html (#5638)Ica
I believe this will fix the dead links that occurred because of sub section renames. Co-authored-by: Yong He <yonghe@outlook.com>
2024-11-20Add link to metal docs and regen TOC (#5616)Ellie Hermaszewska
* Add link to metal docs * Regenerate TOC --------- Co-authored-by: Yong He <yonghe@outlook.com>
2024-09-05Various documentation improvements. (#5017)Yong He
2024-09-05Support `where` clause and type equality constraint. (#4986)Yong He
* Support `where` clause. * Fix. * Fix parser. * Enhance test to cover traditional __generic syntax. * Update user-guide. * Support `where` clause on associatedtype. * Fix. * Put in more comments.
2024-09-05Document All Capability Atoms and Profiles (#5008)ArielG-NV
* Document All Capability Atoms and Profiles Fixes: #4125 Unimplemented Considerations: 1. This PR does not add support to query all capability-atom's from a command-line option. It is understood that this might be desired, due to this, the logic to generate `docs\user-guide\a3-02-reference-capability-atoms.md` was made to be "command-line friendly" so minimal changes are needed to pipe our documentation into a command-line option if this change is to be added. Changes: 1. Added a way to document atoms inside `.capdef`. Method to document is described under `source\slang\slang-capabilities.capdef`. The goal is to error if a public atom does not have any form of documentation to ensure we always have up-to-date documentation to guide user on what an atom is/does. * The following `.capdef` file syntax was added * /// [HEADER_GROUP] * /// regular comment 2. When capability generator runs it auto-generates `docs\user-guide\a3-02-reference-capability-atoms.md` 3. Added to the user-guide 3 sections: `Reference`, `Reference -> Capability Profiles`, `Reference -> Capability atoms` section
2024-09-04Add Documentation For Auto-Generated Constructors & Initializer Lists (#4988)ArielG-NV
* Add documentation for auto-generated constructors & Initializer Lists fixes: #4903 Add documentation for auto-generated constructors & Initializer Lists, the logic behind this PR is on #4854 * clean up documentation as per review comments --------- Co-authored-by: Yong He <yonghe@outlook.com>
2024-08-30User guide page for SPIR-V target specific information (#4815)Jay Kwak
Adding a user guide page for SPIR-V specific features.
2024-08-19Tuple swizzling, concat, comparison and `countof`. (#4856)Yong He
* Tuple swizzling and element access. * Update proposal status. * Cleanup. * Fix merrge error. * Address review.
2024-07-23Add Metal to user-guide/09-targets.md (#4703)Jay Kwak
* Add Metal to user-guide/09-targets.md Partially resolves #4262 The description of "Parameter passing" part for Metal is related to PR #4022
2024-07-15Move if_let syntax to convenience-features section (#4628)kaizhangNV
* Move if_let syntax to convenience-features section * Fix the syntax for setting up an anchor * update the comment on sample code * Add example for if_let syntax * Address the comments
2024-07-10Add reflection API for functions. (#4587)Yong He
* Add reflection API for functions. This change adds `SlangFunctionReflection` type in the reflection API that provides methods for querying function result type, parameters and user-defined attributes. `ProgramLayout::findFunctionByName` can now find a function with the given name and returns a `FunctionReflection`. `IEntryPoint` now has a `getFunctionReflection` method that returns an `FunctionReflection` for the entrypoint. * More modifiers; make reflection API consistent.
2024-07-10Add user guide section on user-defined attributes. (#4557)Yong He
* Add user guide section on user-defined attributes. * Update toc
2024-05-23Fix pointers link in userguide (#4217)cheneym2
Adding (limited) to the header in a previous doc change broke the link. Co-authored-by: Jay Kwak <82421531+jkwak-work@users.noreply.github.com>
2024-04-02Update user guilde for new features. (#3875)Yong He
2024-03-17Remove out of date documentation on compilation API. (#3785)Yong He
* Remove out of date documentation on compilation API. * Update toc.
2024-03-08Add documentation for uniformity analysis. (#3721)Yong He
2024-03-04Add user-guide section on pointers. (#3670)Yong He
2024-03-01Update doc TOC (#3657)Yong He
2024-02-27Update documentation TOC. (#3641)Yong He
2024-02-27Update doc links. (#3640)Yong He
2024-02-27Add documentation for link-time specialization. (#3638)Yong He
2024-02-05Add documentation on capability system. (#3549)Yong He
Fixes #3454.
2023-12-15Add doc for special scoping syntax. (#3416)Yong He
Co-authored-by: Yong He <yhe@nvidia.com>
2023-12-11Diagnose for invalid decl nesting + namespace lookup fixes. (#3397)Yong He
* Diagnose for invalid decl nesting. * Fix. * Fix. * Fix. * Fix `namespace` lookup and `using` resolution. * fix project files. * revert project files. * Enhance namespace syntax, docs. * Fixes. --------- Co-authored-by: Yong He <yhe@nvidia.com>
2023-12-06Change default visibility of interface members and update docs. (#3381)Yong He
* Update behavior around interfaces and docs. * Update toc --------- Co-authored-by: Yong He <yhe@nvidia.com>
2023-12-06Support visibility control and default to `internal`. (#3380)Yong He
* Support visibility control and default to `internal`. * Fix wip. * Fixes. * Fix. * Fix test. * Add legacy language detection and compatibility for existing code. * Add doc. --------- Co-authored-by: Yong He <yhe@nvidia.com>
2023-10-13Add documentation on target intrinsics. (#3276)Yong He
Co-authored-by: Yong He <yhe@nvidia.com>
2023-05-04Update user-guide. (#2868)Yong He
Co-authored-by: Yong He <yhe@nvidia.com>
2023-03-31Update TOC (#2764)Yong He
Co-authored-by: Yong He <yhe@nvidia.com>
2023-03-29Update TOC (#2756)Yong He
Co-authored-by: Yong He <yhe@nvidia.com>
2023-03-28Update toc (#2749)Yong He
Co-authored-by: Yong He <yhe@nvidia.com>
2023-03-28Add slangpy doc, fix cuda prelude. (#2748)Yong He
* Add slangpy doc, fix cuda prelude. * more bug fix. * fix. * fix. * More fix. * fix. * f * fix prelude. * update prelude. * update doc * Update prelude. * add zeros_like * update doc. --------- Co-authored-by: Yong He <yhe@nvidia.com>
2023-03-16Add test case for `makeStruct` transcription. (#2705)Yong He
* Add test case for `makeStruct` transcription. * Update documentation on `no_diff`. * Update toc --------- Co-authored-by: Yong He <yhe@nvidia.com>
2023-03-09Update restrictions sections in autodiff doc. (#2694)Yong He
* Update restrictions section in autodiff doc. * Update restrictions sections in autodiff doc. --------- Co-authored-by: Yong He <yhe@nvidia.com>
2023-02-08Update autodiff documentation with more precise math definitions. (#2636)Yong He
Co-authored-by: Yong He <yhe@nvidia.com>
2023-02-06Update documentation (#2631)Yong He
Co-authored-by: Yong He <yhe@nvidia.com>
2023-02-06Update documentation TOC (#2629)Yong He
Co-authored-by: Yong He <yhe@nvidia.com>
generated by cgit v1.2.3 (git 2.39.1) at 2026-06-11 01:12:36 +0000