Skip to content

Commit 0c81bfe

Browse files
committed
Update doc.
1 parent 1f93577 commit 0c81bfe

File tree

8 files changed

+1154
-1146
lines changed

8 files changed

+1154
-1146
lines changed

docs/_includes/stdlib-reference-toc.html

+796
Large diffs are not rendered by default.

docs/_layouts/stdlib-reference.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@
192192
Table of Contents</button>
193193
<div id="tocColumn">
194194
<div id="tocInner">
195-
{% include_relative toc.html %}
195+
{% include stdlib-reference-toc.html %}
196196
</div>
197197
</div>
198198
<div id="rightColumn">

docs/build_reference.ps1

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Remove-Item -Path ".\stdlib-reference\global-decls" -Recurse -Force
2+
Remove-Item -Path ".\stdlib-reference\interfaces" -Recurse -Force
3+
Remove-Item -Path ".\stdlib-reference\types" -Recurse -Force
4+
5+
cd stdlib-reference
6+
& ../../build/Release/bin/slangc -compile-stdlib -doc
7+
cd ../
8+
Move-Item -Path ".\stdlib-reference\toc.html" -Destination ".\_includes\stdlib-reference-toc.html" -Force

docs/stdlib-reference/global-decls/index.md

+284-284
Large diffs are not rendered by default.

docs/stdlib-reference/interfaces/index.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@ layout: stdlib-reference
55

66
Slang's Standard Library defines the following interfaces:
77

8-
- [IArithmetic](interfaces/IArithmetic/index.md)
9-
- [IArithmeticAtomicable](interfaces/IArithmeticAtomicable/index.md)
10-
- [IAtomicable](interfaces/IAtomicable/index.md)
11-
- [IBitAtomicable](interfaces/IBitAtomicable/index.md)
12-
- [IBufferDataLayout](interfaces/IBufferDataLayout/index.md)
13-
- [IComparable](interfaces/IComparable/index.md)
14-
- [IDefaultInitializable](interfaces/IDefaultInitializable/index.md)
15-
- [IDifferentiable](interfaces/IDifferentiable/index.md)
16-
- [IDifferentiableFunc](interfaces/IDifferentiableFunc/index.md)
17-
- [IDifferentiableMutatingFunc](interfaces/IDifferentiableMutatingFunc/index.md)
18-
- [IDifferentiablePtrType](interfaces/IDifferentiablePtrType/index.md)
19-
- [IFloat](interfaces/IFloat/index.md)
20-
- [IFunc](interfaces/IFunc/index.md)
21-
- [IInteger](interfaces/IInteger/index.md)
22-
- [ILogical](interfaces/ILogical/index.md)
23-
- [IMutatingFunc](interfaces/IMutatingFunc/index.md)
24-
- [IRangedValue](interfaces/IRangedValue/index.md)
8+
- [IArithmetic](interfaces/IArithmetic/index)
9+
- [IArithmeticAtomicable](interfaces/IArithmeticAtomicable/index)
10+
- [IAtomicable](interfaces/IAtomicable/index)
11+
- [IBitAtomicable](interfaces/IBitAtomicable/index)
12+
- [IBufferDataLayout](interfaces/IBufferDataLayout/index)
13+
- [IComparable](interfaces/IComparable/index)
14+
- [IDefaultInitializable](interfaces/IDefaultInitializable/index)
15+
- [IDifferentiable](interfaces/IDifferentiable/index)
16+
- [IDifferentiableFunc](interfaces/IDifferentiableFunc/index)
17+
- [IDifferentiableMutatingFunc](interfaces/IDifferentiableMutatingFunc/index)
18+
- [IDifferentiablePtrType](interfaces/IDifferentiablePtrType/index)
19+
- [IFloat](interfaces/IFloat/index)
20+
- [IFunc](interfaces/IFunc/index)
21+
- [IInteger](interfaces/IInteger/index)
22+
- [ILogical](interfaces/ILogical/index)
23+
- [IMutatingFunc](interfaces/IMutatingFunc/index)
24+
- [IRangedValue](interfaces/IRangedValue/index)

docs/stdlib-reference/toc.html

-796
This file was deleted.

docs/stdlib-reference/types/index.md

+46-46
Original file line numberDiff line numberDiff line change
@@ -5,49 +5,49 @@ layout: stdlib-reference
55

66
Slang's Standard Library defines the following types:
77

8-
- [AppendStructuredBuffer](types/AppendStructuredBuffer/index.md)
9-
- [Array](types/Array/index.md)
10-
- [Atomic](types/Atomic/index.md)
11-
- [BuiltInTriangleIntersectionAttributes](types/BuiltInTriangleIntersectionAttributes/index.md)
12-
- [ByteAddressBuffer](types/ByteAddressBuffer/index.md)
13-
- [ConstantBuffer](types/ConstantBuffer/index.md)
14-
- [ConsumeStructuredBuffer](types/ConsumeStructuredBuffer/index.md)
15-
- [DefaultDataLayout](types/DefaultDataLayout/index.md)
16-
- [DifferentialPair](types/DifferentialPair/index.md)
17-
- [DifferentialPtrPair](types/DifferentialPtrPair/index.md)
18-
- [HitObject](types/HitObject/index.md)
19-
- [InputPatch](types/InputPatch/index.md)
20-
- [LineStream](types/LineStream/index.md)
21-
- [MemoryOrder](types/MemoryOrder/index.md)
22-
- [NativeString](types/NativeString/index.md)
23-
- [Optional](types/Optional/index.md)
24-
- [OutputIndices](types/OutputIndices/index.md)
25-
- [OutputPatch](types/OutputPatch/index.md)
26-
- [OutputPrimitives](types/OutputPrimitives/index.md)
27-
- [OutputVertices](types/OutputVertices/index.md)
28-
- [ParameterBlock](types/ParameterBlock/index.md)
29-
- [PointStream](types/PointStream/index.md)
30-
- [Ptr](types/Ptr/index.md)
31-
- [RWByteAddressBuffer](types/RWByteAddressBuffer/index.md)
32-
- [RWStructuredBuffer](types/RWStructuredBuffer/index.md)
33-
- [RasterizerOrderedByteAddressBuffer](types/RasterizerOrderedByteAddressBuffer/index.md)
34-
- [RasterizerOrderedStructuredBuffer](types/RasterizerOrderedStructuredBuffer/index.md)
35-
- [RayDesc](types/RayDesc/index.md)
36-
- [RayQuery](types/RayQuery/index.md)
37-
- [RaytracingAccelerationStructure](types/RaytracingAccelerationStructure/index.md)
38-
- [SAMPLER_FEEDBACK_MIN_MIP](types/SAMPLER_FEEDBACK_MIN_MIP/index.md)
39-
- [SAMPLER_FEEDBACK_MIP_REGION_USED](types/SAMPLER_FEEDBACK_MIP_REGION_USED/index.md)
40-
- [SamplerComparisonState](types/SamplerComparisonState/index.md)
41-
- [SamplerState](types/SamplerState/index.md)
42-
- [ScalarDataLayout](types/ScalarDataLayout/index.md)
43-
- [Std140DataLayout](types/Std140DataLayout/index.md)
44-
- [Std430DataLayout](types/Std430DataLayout/index.md)
45-
- [String](types/String/index.md)
46-
- [StructuredBuffer](types/StructuredBuffer/index.md)
47-
- [TextureBuffer](types/TextureBuffer/index.md)
48-
- [TextureFootprint](types/TextureFootprint/index.md)
49-
- [TriangleStream](types/TriangleStream/index.md)
50-
- [Tuple](types/Tuple/index.md)
51-
- [_Texture](types/_Texture/index.md)
52-
- [matrix](types/matrix/index.md)
53-
- [vector](types/vector/index.md)
8+
- [AppendStructuredBuffer](types/AppendStructuredBuffer/index)
9+
- [Array](types/Array/index)
10+
- [Atomic](types/Atomic/index)
11+
- [BuiltInTriangleIntersectionAttributes](types/BuiltInTriangleIntersectionAttributes/index)
12+
- [ByteAddressBuffer](types/ByteAddressBuffer/index)
13+
- [ConstantBuffer](types/ConstantBuffer/index)
14+
- [ConsumeStructuredBuffer](types/ConsumeStructuredBuffer/index)
15+
- [DefaultDataLayout](types/DefaultDataLayout/index)
16+
- [DifferentialPair](types/DifferentialPair/index)
17+
- [DifferentialPtrPair](types/DifferentialPtrPair/index)
18+
- [HitObject](types/HitObject/index)
19+
- [InputPatch](types/InputPatch/index)
20+
- [LineStream](types/LineStream/index)
21+
- [MemoryOrder](types/MemoryOrder/index)
22+
- [NativeString](types/NativeString/index)
23+
- [Optional](types/Optional/index)
24+
- [OutputIndices](types/OutputIndices/index)
25+
- [OutputPatch](types/OutputPatch/index)
26+
- [OutputPrimitives](types/OutputPrimitives/index)
27+
- [OutputVertices](types/OutputVertices/index)
28+
- [ParameterBlock](types/ParameterBlock/index)
29+
- [PointStream](types/PointStream/index)
30+
- [Ptr](types/Ptr/index)
31+
- [RWByteAddressBuffer](types/RWByteAddressBuffer/index)
32+
- [RWStructuredBuffer](types/RWStructuredBuffer/index)
33+
- [RasterizerOrderedByteAddressBuffer](types/RasterizerOrderedByteAddressBuffer/index)
34+
- [RasterizerOrderedStructuredBuffer](types/RasterizerOrderedStructuredBuffer/index)
35+
- [RayDesc](types/RayDesc/index)
36+
- [RayQuery](types/RayQuery/index)
37+
- [RaytracingAccelerationStructure](types/RaytracingAccelerationStructure/index)
38+
- [SAMPLER_FEEDBACK_MIN_MIP](types/SAMPLER_FEEDBACK_MIN_MIP/index)
39+
- [SAMPLER_FEEDBACK_MIP_REGION_USED](types/SAMPLER_FEEDBACK_MIP_REGION_USED/index)
40+
- [SamplerComparisonState](types/SamplerComparisonState/index)
41+
- [SamplerState](types/SamplerState/index)
42+
- [ScalarDataLayout](types/ScalarDataLayout/index)
43+
- [Std140DataLayout](types/Std140DataLayout/index)
44+
- [Std430DataLayout](types/Std430DataLayout/index)
45+
- [String](types/String/index)
46+
- [StructuredBuffer](types/StructuredBuffer/index)
47+
- [TextureBuffer](types/TextureBuffer/index)
48+
- [TextureFootprint](types/TextureFootprint/index)
49+
- [TriangleStream](types/TriangleStream/index)
50+
- [Tuple](types/Tuple/index)
51+
- [_Texture](types/_Texture/index)
52+
- [matrix](types/matrix/index)
53+
- [vector](types/vector/index)

source/slang/slang-doc-markdown-writer.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -1353,7 +1353,7 @@ void generateSectionIndexPage(DocumentationConfig& config, DocumentPage* page)
13531353

13541354
for (auto child : page->children)
13551355
{
1356-
sb << "- [" << child->shortName << "](" << child->path << ")\n";
1356+
sb << "- [" << child->shortName << "](" << Path::getPathWithoutExt(child->path) << ")\n";
13571357
}
13581358
}
13591359

@@ -1435,7 +1435,7 @@ void escapeHTMLContent(StringBuilder& sb, UnownedStringSlice str)
14351435

14361436
void writeTOCImpl(StringBuilder& sb, DocumentPage* page)
14371437
{
1438-
sb << R"(<li data-link=")" << page->path << R"("><span>)";
1438+
sb << R"(<li data-link=")" << Path::getPathWithoutExt(page->path) << R"("><span>)";
14391439
escapeHTMLContent(sb, page->shortName.getUnownedSlice());
14401440
sb << "</span>\n";
14411441
writeTOCChildren(sb, page);

0 commit comments

Comments
 (0)