From 013cebb258fa007cd634996f912896c79a8f520b Mon Sep 17 00:00:00 2001 From: Aidan Foster Date: Fri, 9 May 2025 17:48:28 -0700 Subject: [PATCH 1/4] Rename stdlib reference URLs --- .gitmodules | 4 ++-- _data/documentation.yaml | 2 +- docs/conf.py | 10 +++++----- docs/external/stdlib-reference | 1 - docs/index.rst | 2 +- docs/understanding-generics.md | 4 ++-- 6 files changed, 11 insertions(+), 12 deletions(-) delete mode 160000 docs/external/stdlib-reference diff --git a/.gitmodules b/.gitmodules index 33f0efd1..d7591234 100644 --- a/.gitmodules +++ b/.gitmodules @@ -4,6 +4,6 @@ [submodule "docs/external/slangpy"] path = docs/external/slangpy url = https://github.com/shader-slang/slangpy.git -[submodule "docs/external/stdlib-reference"] - path = docs/external/stdlib-reference +[submodule "docs/external/core-module-reference"] + path = docs/external/core-module-reference url = https://github.com/shader-slang/stdlib-reference.git diff --git a/_data/documentation.yaml b/_data/documentation.yaml index 2384092d..ce68e3c3 100644 --- a/_data/documentation.yaml +++ b/_data/documentation.yaml @@ -5,7 +5,7 @@ overview: link_label: "User Guide" - title: "Standard Modules Reference" description: "The reference of the standard modules that comes with the Slang compiler." - link_url: "https://docs.shader-slang.org/en/latest/external/stdlib-reference/" + link_url: "https://docs.shader-slang.org/en/latest/external/core-module-reference/" link_label: "Modules Reference" - title: "Language Specification" description: "The formal specification of the Slang programming language. Work in progress.." diff --git a/docs/conf.py b/docs/conf.py index 57192f5c..64793e1a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -69,11 +69,11 @@ def setup(app): ] include_patterns = ['index.rst', '*.md', "external/slang/docs/user-guide/*.md", - "external/stdlib-reference/index.md", - "external/stdlib-reference/attributes/**", - "external/stdlib-reference/global-decls/**", - "external/stdlib-reference/interfaces/**", - "external/stdlib-reference/types/**", + "external/core-module-reference/index.md", + "external/core-module-reference/attributes/**", + "external/core-module-reference/global-decls/**", + "external/core-module-reference/interfaces/**", + "external/core-module-reference/types/**", "external/slangpy/docs/**", ] diff --git a/docs/external/stdlib-reference b/docs/external/stdlib-reference deleted file mode 160000 index 81c475d0..00000000 --- a/docs/external/stdlib-reference +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 81c475d046edec80c63f17601b8ffb7abce98851 diff --git a/docs/index.rst b/docs/index.rst index 2e8fd81b..c5bd319f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,7 +7,7 @@ Slang Documentation :titlesonly: User Guide - Standard Modules Reference + Standard Modules Reference Language Spec SlangPy User Guide Feature Matureness diff --git a/docs/understanding-generics.md b/docs/understanding-generics.md index 3576d29b..fe4dcc1b 100644 --- a/docs/understanding-generics.md +++ b/docs/understanding-generics.md @@ -334,9 +334,9 @@ float addValue(T v0, T v1) where T : IArithmetic { return v0 + v1; } It is still possible to write functions which can generically operate over scalars and vectors, for example using the -[`IArithmetic`](https://shader-slang.com/stdlib-reference/interfaces/iarithmetic-01/index.html) +[`IArithmetic`](https://docs.shader-slang.org/en/latest/external/core-module-reference/interfaces/iarithmetic-01/index.html) or -[`IFloat`](https://shader-slang.com/stdlib-reference/interfaces/ifloat-01/index.html) +[`IFloat`](https://docs.shader-slang.org/en/latest/external/core-module-reference/interfaces/ifloat-01/index.html) interfaces. ### Advanced Generic Features From 71ac093fd923b276e9e70d07acebf2220283a8cf Mon Sep 17 00:00:00 2001 From: Aidan Foster Date: Tue, 13 May 2025 09:18:57 -0700 Subject: [PATCH 2/4] Update conflicting submodule --- docs/external/core-module-reference | 1 + 1 file changed, 1 insertion(+) create mode 160000 docs/external/core-module-reference diff --git a/docs/external/core-module-reference b/docs/external/core-module-reference new file mode 160000 index 00000000..6962665d --- /dev/null +++ b/docs/external/core-module-reference @@ -0,0 +1 @@ +Subproject commit 6962665dbeb4fd4766ab122a98ffd483247874d8 From 8a43e21a1926a32703fe6d09a88e9be5b0c57fe3 Mon Sep 17 00:00:00 2001 From: Aidan Foster Date: Tue, 13 May 2025 09:44:06 -0700 Subject: [PATCH 3/4] Temporarily add back stdlib-reference alongside core-module-reference --- .gitmodules | 3 +++ docs/external/stdlib-reference | 1 + 2 files changed, 4 insertions(+) create mode 160000 docs/external/stdlib-reference diff --git a/.gitmodules b/.gitmodules index d7591234..4bd1ea4c 100644 --- a/.gitmodules +++ b/.gitmodules @@ -7,3 +7,6 @@ [submodule "docs/external/core-module-reference"] path = docs/external/core-module-reference url = https://github.com/shader-slang/stdlib-reference.git +[submodule "docs/external/stdlib-reference"] + path = docs/external/stdlib-reference + url = https://github.com/shader-slang/stdlib-reference.git diff --git a/docs/external/stdlib-reference b/docs/external/stdlib-reference new file mode 160000 index 00000000..73834b7b --- /dev/null +++ b/docs/external/stdlib-reference @@ -0,0 +1 @@ +Subproject commit 73834b7be64e4c0e62b35cdb73d4a95bf798985d From 8e05d1add912f08959315e76e3d7d13288dee197 Mon Sep 17 00:00:00 2001 From: Aidan Foster Date: Tue, 13 May 2025 09:46:10 -0700 Subject: [PATCH 4/4] Remove stdlib-reference submodule after rename is complete --- .gitmodules | 3 --- docs/external/stdlib-reference | 1 - 2 files changed, 4 deletions(-) delete mode 160000 docs/external/stdlib-reference diff --git a/.gitmodules b/.gitmodules index 4bd1ea4c..d7591234 100644 --- a/.gitmodules +++ b/.gitmodules @@ -7,6 +7,3 @@ [submodule "docs/external/core-module-reference"] path = docs/external/core-module-reference url = https://github.com/shader-slang/stdlib-reference.git -[submodule "docs/external/stdlib-reference"] - path = docs/external/stdlib-reference - url = https://github.com/shader-slang/stdlib-reference.git diff --git a/docs/external/stdlib-reference b/docs/external/stdlib-reference deleted file mode 160000 index 78b2b203..00000000 --- a/docs/external/stdlib-reference +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 78b2b20373f488517d166861bb2ef00c6918ce05