Skip to content

Commit aaf059a

Browse files
authored
Rename stdlib reference URLs (#100)
Related to shader-slang/slang#6770 Since the Standard Module Reference repo is going to be renamed eventually, this change renames the submodule in this repo to core-module-reference, changing the readthedocs URLs accordingly, while these docs are still relatively new rather than change the URLs later on or have URLs with the old repo name.
1 parent e57fa55 commit aaf059a

File tree

7 files changed

+12
-12
lines changed

7 files changed

+12
-12
lines changed

.gitmodules

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
[submodule "docs/external/slangpy"]
55
path = docs/external/slangpy
66
url = https://github.com/shader-slang/slangpy.git
7-
[submodule "docs/external/stdlib-reference"]
8-
path = docs/external/stdlib-reference
7+
[submodule "docs/external/core-module-reference"]
8+
path = docs/external/core-module-reference
99
url = https://github.com/shader-slang/stdlib-reference.git

_data/documentation.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ overview:
55
link_label: "User Guide"
66
- title: "Standard Modules Reference"
77
description: "The reference of the standard modules that comes with the Slang compiler."
8-
link_url: "https://docs.shader-slang.org/en/latest/external/stdlib-reference/"
8+
link_url: "https://docs.shader-slang.org/en/latest/external/core-module-reference/"
99
link_label: "Modules Reference"
1010
- title: "Language Specification"
1111
description: "The formal specification of the Slang programming language. Work in progress.."

docs/conf.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,11 @@ def setup(app):
6969
]
7070
include_patterns = ['index.rst', '*.md',
7171
"external/slang/docs/user-guide/*.md",
72-
"external/stdlib-reference/index.md",
73-
"external/stdlib-reference/attributes/**",
74-
"external/stdlib-reference/global-decls/**",
75-
"external/stdlib-reference/interfaces/**",
76-
"external/stdlib-reference/types/**",
72+
"external/core-module-reference/index.md",
73+
"external/core-module-reference/attributes/**",
74+
"external/core-module-reference/global-decls/**",
75+
"external/core-module-reference/interfaces/**",
76+
"external/core-module-reference/types/**",
7777
"external/slangpy/docs/**",
7878
]
7979

Submodule core-module-reference added at 6962665

docs/external/stdlib-reference

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Slang Documentation
77
:titlesonly:
88

99
User Guide <external/slang/docs/user-guide/index>
10-
Standard Modules Reference <external/stdlib-reference/index>
10+
Standard Modules Reference <external/core-module-reference/index>
1111
Language Spec <https://github.com/shader-slang/spec>
1212
SlangPy User Guide <external/slangpy/docs/index.rst>
1313
Feature Matureness <feature_matureness>

docs/understanding-generics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -334,9 +334,9 @@ float addValue<T>(T v0, T v1) where T : IArithmetic { return v0 + v1; }
334334

335335
It is still possible to write functions which can generically operate over
336336
scalars and vectors, for example using the
337-
[`IArithmetic`](https://shader-slang.com/stdlib-reference/interfaces/iarithmetic-01/index.html)
337+
[`IArithmetic`](https://docs.shader-slang.org/en/latest/external/core-module-reference/interfaces/iarithmetic-01/index.html)
338338
or
339-
[`IFloat`](https://shader-slang.com/stdlib-reference/interfaces/ifloat-01/index.html)
339+
[`IFloat`](https://docs.shader-slang.org/en/latest/external/core-module-reference/interfaces/ifloat-01/index.html)
340340
interfaces.
341341

342342
### Advanced Generic Features

0 commit comments

Comments
 (0)