Update link path.

csyonghe · csyonghe · commit f876428e8605 · 2024-10-02T09:38:02.000-07:00
diff --git a/docs/stdlib-reference/config.txt b/docs/stdlib-reference/config.txt
@@ -1,5 +1,6 @@
-@titile: Slang Standard Library Reference
+@title: Slang Standard Library Reference
 @libname: Slang's Standard Library
+@rootdir: /docs/stdlib-reference/
 
 @preamble:
 ---
diff --git a/docs/stdlib-reference/global-decls/index.md b/docs/stdlib-reference/global-decls/index.md
diff --git a/docs/stdlib-reference/interfaces/index.md b/docs/stdlib-reference/interfaces/index.md
@@ -5,20 +5,20 @@ layout: stdlib-reference
 
 Slang's Standard Library defines the following interfaces:
 
-- [IArithmetic](interfaces/IArithmetic/index)
-- [IArithmeticAtomicable](interfaces/IArithmeticAtomicable/index)
-- [IAtomicable](interfaces/IAtomicable/index)
-- [IBitAtomicable](interfaces/IBitAtomicable/index)
-- [IBufferDataLayout](interfaces/IBufferDataLayout/index)
-- [IComparable](interfaces/IComparable/index)
-- [IDefaultInitializable](interfaces/IDefaultInitializable/index)
-- [IDifferentiable](interfaces/IDifferentiable/index)
-- [IDifferentiableFunc](interfaces/IDifferentiableFunc/index)
-- [IDifferentiableMutatingFunc](interfaces/IDifferentiableMutatingFunc/index)
-- [IDifferentiablePtrType](interfaces/IDifferentiablePtrType/index)
-- [IFloat](interfaces/IFloat/index)
-- [IFunc](interfaces/IFunc/index)
-- [IInteger](interfaces/IInteger/index)
-- [ILogical](interfaces/ILogical/index)
-- [IMutatingFunc](interfaces/IMutatingFunc/index)
-- [IRangedValue](interfaces/IRangedValue/index)
+- [IArithmetic](/docs/stdlib-reference/interfaces/IArithmetic/index)
+- [IArithmeticAtomicable](/docs/stdlib-reference/interfaces/IArithmeticAtomicable/index)
+- [IAtomicable](/docs/stdlib-reference/interfaces/IAtomicable/index)
+- [IBitAtomicable](/docs/stdlib-reference/interfaces/IBitAtomicable/index)
+- [IBufferDataLayout](/docs/stdlib-reference/interfaces/IBufferDataLayout/index)
+- [IComparable](/docs/stdlib-reference/interfaces/IComparable/index)
+- [IDefaultInitializable](/docs/stdlib-reference/interfaces/IDefaultInitializable/index)
+- [IDifferentiable](/docs/stdlib-reference/interfaces/IDifferentiable/index)
+- [IDifferentiableFunc](/docs/stdlib-reference/interfaces/IDifferentiableFunc/index)
+- [IDifferentiableMutatingFunc](/docs/stdlib-reference/interfaces/IDifferentiableMutatingFunc/index)
+- [IDifferentiablePtrType](/docs/stdlib-reference/interfaces/IDifferentiablePtrType/index)
+- [IFloat](/docs/stdlib-reference/interfaces/IFloat/index)
+- [IFunc](/docs/stdlib-reference/interfaces/IFunc/index)
+- [IInteger](/docs/stdlib-reference/interfaces/IInteger/index)
+- [ILogical](/docs/stdlib-reference/interfaces/ILogical/index)
+- [IMutatingFunc](/docs/stdlib-reference/interfaces/IMutatingFunc/index)
+- [IRangedValue](/docs/stdlib-reference/interfaces/IRangedValue/index)
diff --git a/docs/stdlib-reference/toc.html b/docs/stdlib-reference/toc.html
diff --git a/docs/stdlib-reference/types/index.md b/docs/stdlib-reference/types/index.md
@@ -5,49 +5,49 @@ layout: stdlib-reference
 
 Slang's Standard Library defines the following types:
 
-- [AppendStructuredBuffer](types/AppendStructuredBuffer/index)
-- [Array](types/Array/index)
-- [Atomic](types/Atomic/index)
-- [BuiltInTriangleIntersectionAttributes](types/BuiltInTriangleIntersectionAttributes/index)
-- [ByteAddressBuffer](types/ByteAddressBuffer/index)
-- [ConstantBuffer](types/ConstantBuffer/index)
-- [ConsumeStructuredBuffer](types/ConsumeStructuredBuffer/index)
-- [DefaultDataLayout](types/DefaultDataLayout/index)
-- [DifferentialPair](types/DifferentialPair/index)
-- [DifferentialPtrPair](types/DifferentialPtrPair/index)
-- [HitObject](types/HitObject/index)
-- [InputPatch](types/InputPatch/index)
-- [LineStream](types/LineStream/index)
-- [MemoryOrder](types/MemoryOrder/index)
-- [NativeString](types/NativeString/index)
-- [Optional](types/Optional/index)
-- [OutputIndices](types/OutputIndices/index)
-- [OutputPatch](types/OutputPatch/index)
-- [OutputPrimitives](types/OutputPrimitives/index)
-- [OutputVertices](types/OutputVertices/index)
-- [ParameterBlock](types/ParameterBlock/index)
-- [PointStream](types/PointStream/index)
-- [Ptr](types/Ptr/index)
-- [RWByteAddressBuffer](types/RWByteAddressBuffer/index)
-- [RWStructuredBuffer](types/RWStructuredBuffer/index)
-- [RasterizerOrderedByteAddressBuffer](types/RasterizerOrderedByteAddressBuffer/index)
-- [RasterizerOrderedStructuredBuffer](types/RasterizerOrderedStructuredBuffer/index)
-- [RayDesc](types/RayDesc/index)
-- [RayQuery](types/RayQuery/index)
-- [RaytracingAccelerationStructure](types/RaytracingAccelerationStructure/index)
-- [SAMPLER_FEEDBACK_MIN_MIP](types/SAMPLER_FEEDBACK_MIN_MIP/index)
-- [SAMPLER_FEEDBACK_MIP_REGION_USED](types/SAMPLER_FEEDBACK_MIP_REGION_USED/index)
-- [SamplerComparisonState](types/SamplerComparisonState/index)
-- [SamplerState](types/SamplerState/index)
-- [ScalarDataLayout](types/ScalarDataLayout/index)
-- [Std140DataLayout](types/Std140DataLayout/index)
-- [Std430DataLayout](types/Std430DataLayout/index)
-- [String](types/String/index)
-- [StructuredBuffer](types/StructuredBuffer/index)
-- [TextureBuffer](types/TextureBuffer/index)
-- [TextureFootprint](types/TextureFootprint/index)
-- [TriangleStream](types/TriangleStream/index)
-- [Tuple](types/Tuple/index)
-- [_Texture](types/_Texture/index)
-- [matrix](types/matrix/index)
-- [vector](types/vector/index)
+- [AppendStructuredBuffer](/docs/stdlib-reference/types/AppendStructuredBuffer/index)
+- [Array](/docs/stdlib-reference/types/Array/index)
+- [Atomic](/docs/stdlib-reference/types/Atomic/index)
+- [BuiltInTriangleIntersectionAttributes](/docs/stdlib-reference/types/BuiltInTriangleIntersectionAttributes/index)
+- [ByteAddressBuffer](/docs/stdlib-reference/types/ByteAddressBuffer/index)
+- [ConstantBuffer](/docs/stdlib-reference/types/ConstantBuffer/index)
+- [ConsumeStructuredBuffer](/docs/stdlib-reference/types/ConsumeStructuredBuffer/index)
+- [DefaultDataLayout](/docs/stdlib-reference/types/DefaultDataLayout/index)
+- [DifferentialPair](/docs/stdlib-reference/types/DifferentialPair/index)
+- [DifferentialPtrPair](/docs/stdlib-reference/types/DifferentialPtrPair/index)
+- [HitObject](/docs/stdlib-reference/types/HitObject/index)
+- [InputPatch](/docs/stdlib-reference/types/InputPatch/index)
+- [LineStream](/docs/stdlib-reference/types/LineStream/index)
+- [MemoryOrder](/docs/stdlib-reference/types/MemoryOrder/index)
+- [NativeString](/docs/stdlib-reference/types/NativeString/index)
+- [Optional](/docs/stdlib-reference/types/Optional/index)
+- [OutputIndices](/docs/stdlib-reference/types/OutputIndices/index)
+- [OutputPatch](/docs/stdlib-reference/types/OutputPatch/index)
+- [OutputPrimitives](/docs/stdlib-reference/types/OutputPrimitives/index)
+- [OutputVertices](/docs/stdlib-reference/types/OutputVertices/index)
+- [ParameterBlock](/docs/stdlib-reference/types/ParameterBlock/index)
+- [PointStream](/docs/stdlib-reference/types/PointStream/index)
+- [Ptr](/docs/stdlib-reference/types/Ptr/index)
+- [RWByteAddressBuffer](/docs/stdlib-reference/types/RWByteAddressBuffer/index)
+- [RWStructuredBuffer](/docs/stdlib-reference/types/RWStructuredBuffer/index)
+- [RasterizerOrderedByteAddressBuffer](/docs/stdlib-reference/types/RasterizerOrderedByteAddressBuffer/index)
+- [RasterizerOrderedStructuredBuffer](/docs/stdlib-reference/types/RasterizerOrderedStructuredBuffer/index)
+- [RayDesc](/docs/stdlib-reference/types/RayDesc/index)
+- [RayQuery](/docs/stdlib-reference/types/RayQuery/index)
+- [RaytracingAccelerationStructure](/docs/stdlib-reference/types/RaytracingAccelerationStructure/index)
+- [SAMPLER_FEEDBACK_MIN_MIP](/docs/stdlib-reference/types/SAMPLER_FEEDBACK_MIN_MIP/index)
+- [SAMPLER_FEEDBACK_MIP_REGION_USED](/docs/stdlib-reference/types/SAMPLER_FEEDBACK_MIP_REGION_USED/index)
+- [SamplerComparisonState](/docs/stdlib-reference/types/SamplerComparisonState/index)
+- [SamplerState](/docs/stdlib-reference/types/SamplerState/index)
+- [ScalarDataLayout](/docs/stdlib-reference/types/ScalarDataLayout/index)
+- [Std140DataLayout](/docs/stdlib-reference/types/Std140DataLayout/index)
+- [Std430DataLayout](/docs/stdlib-reference/types/Std430DataLayout/index)
+- [String](/docs/stdlib-reference/types/String/index)
+- [StructuredBuffer](/docs/stdlib-reference/types/StructuredBuffer/index)
+- [TextureBuffer](/docs/stdlib-reference/types/TextureBuffer/index)
+- [TextureFootprint](/docs/stdlib-reference/types/TextureFootprint/index)
+- [TriangleStream](/docs/stdlib-reference/types/TriangleStream/index)
+- [Tuple](/docs/stdlib-reference/types/Tuple/index)
+- [_Texture](/docs/stdlib-reference/types/_Texture/index)
+- [matrix](/docs/stdlib-reference/types/matrix/index)
+- [vector](/docs/stdlib-reference/types/vector/index)
diff --git a/source/slang/slang-doc-markdown-writer.cpp b/source/slang/slang-doc-markdown-writer.cpp
@@ -1332,6 +1332,10 @@ void DocumentationConfig::parse(UnownedStringSlice config)
         {
             libName = line.tail(9).trim();
         }
+        else if (line.startsWith(toSlice("@rootdir:")))
+        {
+            rootDir = line.tail(9).trim();
+        }
     }
 }
 
@@ -1340,6 +1344,11 @@ void sortPages(DocumentPage* page)
     page->children.sort([](DocumentPage* a, DocumentPage* b) -> bool { return a->shortName < b->shortName; });
 }
 
+String getDocPath(const DocumentationConfig& config, String path)
+{
+    return config.rootDir + Path::getPathWithoutExt(path);
+}
+
 void generateSectionIndexPage(DocumentationConfig& config, DocumentPage* page)
 {
     // Generate the content for meta section index page.
@@ -1353,7 +1362,7 @@ void generateSectionIndexPage(DocumentationConfig& config, DocumentPage* page)
 
     for (auto child : page->children)
     {
-        sb << "- [" << child->shortName << "](" << Path::getPathWithoutExt(child->path) << ")\n";
+        sb << "- [" << child->shortName << "](" << getDocPath(config, child->path) << ")\n";
     }
 }
 
@@ -1399,9 +1408,9 @@ DocumentPage* DocMarkdownWriter::writeAll(UnownedStringSlice configStr)
     return m_rootPage.get();
 }
 
-void writeTOCImpl(StringBuilder& sb, DocumentPage* page);
+void writeTOCImpl(StringBuilder& sb, DocumentationConfig& config, DocumentPage* page);
 
-void writeTOCChildren(StringBuilder& sb, DocumentPage* page)
+void writeTOCChildren(StringBuilder& sb, DocumentationConfig& config, DocumentPage* page)
 {
     if (page->children.getCount() == 0)
         return;
@@ -1413,7 +1422,7 @@ void writeTOCChildren(StringBuilder& sb, DocumentPage* page)
         sortPages(page);
     for (auto child : page->children)
     {
-        writeTOCImpl(sb, child);
+        writeTOCImpl(sb, config, child);
     }
     sb << "</ul>\n";
 }
@@ -1433,20 +1442,22 @@ void escapeHTMLContent(StringBuilder& sb, UnownedStringSlice str)
     }
 }
 
-void writeTOCImpl(StringBuilder& sb, DocumentPage* page)
+void writeTOCImpl(StringBuilder& sb, DocumentationConfig& config, DocumentPage* page)
 {
-    sb << R"(<li data-link=")" << Path::getPathWithoutExt(page->path) << R"("><span>)";
+    sb << R"(<li data-link=")" << getDocPath(config, page->path) << R"("><span>)";
     escapeHTMLContent(sb, page->shortName.getUnownedSlice());
     sb << "</span>\n";
-    writeTOCChildren(sb, page);
+    writeTOCChildren(sb, config, page);
     sb << "</li>";
 }
 
 String DocMarkdownWriter::writeTOC()
 {
     StringBuilder sb;
-    sb << R"(<ul class="toc_root_list"><li data-link="index"><span>)" << m_config.title << "</span>\n";
-    writeTOCChildren(sb, m_rootPage);
+    sb << R"(<ul class="toc_root_list"><li data-link=")"
+        << m_config.rootDir << R"(index"><span>)"
+        << m_config.title << "</span>\n";
+    writeTOCChildren(sb, m_config, m_rootPage);
     sb << "</li></ul>\n";
     return sb.produceString();
 }
diff --git a/source/slang/slang-doc-markdown-writer.h b/source/slang/slang-doc-markdown-writer.h
@@ -29,6 +29,7 @@ struct DocumentationConfig
     String preamble;
     String title;
     String libName;
+    String rootDir;
     void parse(UnownedStringSlice configStr);
 };
 

Original file line number	Diff line number	Diff line change
`@@ -1332,6 +1332,10 @@ void DocumentationConfig::parse(UnownedStringSlice config)`
`1332`	`1332`	`{`
`1333`	`1333`	`libName = line.tail(9).trim();`
`1334`	`1334`	`}`
	`1335`	`+ else if (line.startsWith(toSlice("@rootdir:")))`
	`1336`	`+ {`
	`1337`	`+ rootDir = line.tail(9).trim();`
	`1338`	`+ }`
`1335`	`1339`	`}`
`1336`	`1340`	`}`
`1337`	`1341`
`@@ -1340,6 +1344,11 @@ void sortPages(DocumentPage* page)`
`1340`	`1344`	`page->children.sort([](DocumentPage* a, DocumentPage* b) -> bool { return a->shortName < b->shortName; });`
`1341`	`1345`	`}`
`1342`	`1346`
	`1347`	`+String getDocPath(const DocumentationConfig& config, String path)`
	`1348`	`+{`
	`1349`	`+ return config.rootDir + Path::getPathWithoutExt(path);`
	`1350`	`+}`
	`1351`	`+`
`1343`	`1352`	`void generateSectionIndexPage(DocumentationConfig& config, DocumentPage* page)`
`1344`	`1353`	`{`
`1345`	`1354`	`// Generate the content for meta section index page.`
`@@ -1353,7 +1362,7 @@ void generateSectionIndexPage(DocumentationConfig& config, DocumentPage* page)`
`1353`	`1362`
`1354`	`1363`	`for (auto child : page->children)`
`1355`	`1364`	`{`
`1356`		`- sb << "- [" << child->shortName << "](" << Path::getPathWithoutExt(child->path) << ")\n";`
	`1365`	`+ sb << "- [" << child->shortName << "](" << getDocPath(config, child->path) << ")\n";`
`1357`	`1366`	`}`
`1358`	`1367`	`}`
`1359`	`1368`
`@@ -1399,9 +1408,9 @@ DocumentPage* DocMarkdownWriter::writeAll(UnownedStringSlice configStr)`
`1399`	`1408`	`return m_rootPage.get();`
`1400`	`1409`	`}`
`1401`	`1410`
`1402`		`-void writeTOCImpl(StringBuilder& sb, DocumentPage* page);`
	`1411`	`+void writeTOCImpl(StringBuilder& sb, DocumentationConfig& config, DocumentPage* page);`
`1403`	`1412`
`1404`		`-void writeTOCChildren(StringBuilder& sb, DocumentPage* page)`
	`1413`	`+void writeTOCChildren(StringBuilder& sb, DocumentationConfig& config, DocumentPage* page)`
`1405`	`1414`	`{`
`1406`	`1415`	`if (page->children.getCount() == 0)`
`1407`	`1416`	`return;`
`@@ -1413,7 +1422,7 @@ void writeTOCChildren(StringBuilder& sb, DocumentPage* page)`
`1413`	`1422`	`sortPages(page);`
`1414`	`1423`	`for (auto child : page->children)`
`1415`	`1424`	`{`
`1416`		`- writeTOCImpl(sb, child);`
	`1425`	`+ writeTOCImpl(sb, config, child);`
`1417`	`1426`	`}`
`1418`	`1427`	`sb << "</ul>\n";`
`1419`	`1428`	`}`
`@@ -1433,20 +1442,22 @@ void escapeHTMLContent(StringBuilder& sb, UnownedStringSlice str)`
`1433`	`1442`	`}`
`1434`	`1443`	`}`
`1435`	`1444`
`1436`		`-void writeTOCImpl(StringBuilder& sb, DocumentPage* page)`
	`1445`	`+void writeTOCImpl(StringBuilder& sb, DocumentationConfig& config, DocumentPage* page)`
`1437`	`1446`	`{`
`1438`		`- sb << R"(<li data-link=")" << Path::getPathWithoutExt(page->path) << R"("><span>)";`
	`1447`	`+ sb << R"(<li data-link=")" << getDocPath(config, page->path) << R"("><span>)";`
`1439`	`1448`	`escapeHTMLContent(sb, page->shortName.getUnownedSlice());`
`1440`	`1449`	`sb << "</span>\n";`
`1441`		`- writeTOCChildren(sb, page);`
	`1450`	`+ writeTOCChildren(sb, config, page);`
`1442`	`1451`	`sb << "</li>";`
`1443`	`1452`	`}`
`1444`	`1453`
`1445`	`1454`	`String DocMarkdownWriter::writeTOC()`
`1446`	`1455`	`{`
`1447`	`1456`	`StringBuilder sb;`
`1448`		`- sb << R"(<ul class="toc_root_list"><li data-link="index"><span>)" << m_config.title << "</span>\n";`
`1449`		`- writeTOCChildren(sb, m_rootPage);`
	`1457`	`+ sb << R"(<ul class="toc_root_list"><li data-link=")"`
	`1458`	`+ << m_config.rootDir << R"(index"><span>)"`
	`1459`	`+ << m_config.title << "</span>\n";`
	`1460`	`+ writeTOCChildren(sb, m_config, m_rootPage);`
`1450`	`1461`	`sb << "</li></ul>\n";`
`1451`	`1462`	`return sb.produceString();`
`1452`	`1463`	`}`