Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion Directory.Packages.props
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,14 @@
<!-- https://github.com/advisories/GHSA-cmhx-cq75-c4mj -->
<PackageVersion Include="System.Text.RegularExpressions" Version="4.3.1" />

<!-- Common packages for solution -->
<!-- Common packages for solution -->
<PackageVersion Include="System.Linq.Async" Version="6.0.3" />
<PackageVersion Include="Ubiquity.NET.InteropHelpers" Version="20.1.8-rc.2" />
<PackageVersion Include="Ubiquity.NET.Extensions" Version="20.1.8-rc.2" />
<PackageVersion Include="Ubiquity.NET.Runtime.Utils" Version="20.1.8-rc.2" />
<PackageVersion Include="Ubiquity.NET.CommandLine" Version="20.1.8-rc.2" />
<PackageVersion Include="Ubiquity.NET.ANTLR.Utils" Version="20.1.8-rc.2" />

<PackageVersion Include="Ubiquity.NET.LibLLVM" Version="20.1.8" />
<PackageVersion Include="Ubiquity.NET.Versioning" Version="6.0.2-beta" />
<PackageVersion Include="Antlr4BuildTasks" Version="12.11.0" />
Expand Down
3 changes: 0 additions & 3 deletions docfx/CommandLine/api/index.md

This file was deleted.

3 changes: 0 additions & 3 deletions docfx/CommandLine/index.md

This file was deleted.

5 changes: 0 additions & 5 deletions docfx/CommandLine/toc.yml

This file was deleted.

6 changes: 0 additions & 6 deletions docfx/SrcGeneration/api/index.md

This file was deleted.

6 changes: 0 additions & 6 deletions docfx/SrcGeneration/index.md

This file was deleted.

5 changes: 0 additions & 5 deletions docfx/SrcGeneration/toc.yml

This file was deleted.

5 changes: 0 additions & 5 deletions docfx/antlr-utils/api/.gitignore

This file was deleted.

2 changes: 0 additions & 2 deletions docfx/antlr-utils/api/index.md

This file was deleted.

24 changes: 0 additions & 24 deletions docfx/antlr-utils/index.md

This file was deleted.

5 changes: 0 additions & 5 deletions docfx/antlr-utils/toc.yml

This file was deleted.

157 changes: 1 addition & 156 deletions docfx/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,64 +11,9 @@
// warnings and returns a non-success value which stops the build.
// Each project is listed in the order they appear in the VS solution explorer so they are easier
// to find and check etc...
{
// Interop helpers library
"memberLayout": "separatePages",
"namespaceLayout": "nested",
"src": [
{
"src": "../src/Ubiquity.NET.InteropHelpers",
"files": [ "**.csproj" ]
}
],
"dest": "interop-helpers/api"
},
//
// NOTE: Ubiquity.NET.Llvm.Interop is intentionally NOT documented (It's considered an implementation detail)
// NOTE: Sample projects are not generating docs, they are... samples 8^)
{
// ANTLR Utilities library
"memberLayout": "separatePages",
"namespaceLayout": "nested",
"src": [
{
"src": "../src/Ubiquity.NET.ANTLR.Utils",
"files": [ "**.csproj" ]
}
],
"dest": "antlr-utils/api"
},
{
// ANTLR Utilities library
"memberLayout": "separatePages",
"namespaceLayout": "nested",
"src": [
{
"src": "../src/Ubiquity.NET.CommandLine",
"files": [ "**.csproj" ]
}
],
"dest": "CommandLine/api"
},
{
// Extensions library
"memberLayout": "separatePages",
"namespaceLayout": "nested",
"src": [
{
"src": "../src/Ubiquity.NET.Extensions",
"files": [ "**.csproj" ]
}
],
"dest": "extensions/api",
"properties": {
// use .NET 8.0 for the TFM as it is multi-targeting
// Sadly, DocFX can't find the dependent project builds if this is .NET 9.0
// and then generates warnings as a result. (DocFX metadata generation is
// pretty well borked and needs replacement as there are a LOT of workarounds
// in this project let alone all the ones found on-line.)
"TargetFramework": "net8.0"
}
},
{
// LLVM OO Wrappers library
"memberLayout": "separatePages",
Expand All @@ -80,38 +25,6 @@
}
],
"dest": "llvm/api"
},
{
// Runtime utilities library
"memberLayout": "separatePages",
"namespaceLayout": "nested",
"src": [
{
"src": "../src/Ubiquity.NET.Runtime.Utils",
"files": [ "**.csproj" ]
}
],
"dest": "runtime-utils/api",
},
{
// SrcGeneration library
"memberLayout": "separatePages",
"namespaceLayout": "nested",
"src": [
{
"src": "../src/Ubiquity.NET.SrcGeneration",
"files": [ "**.csproj" ]
}
],
"dest": "SrcGeneration/api",
"properties": {
// use .NET 8.0 for the TFM as it is multi-targeting
// Sadly, DocFX can't find the dependent project builds if this is .NET 9.0
// and then generates warnings as a result. (DocFX metadata generation is
// pretty well borked and needs replacement as there are a LOT of workarounds
// in this project let alone all the ones found on-line.)
"TargetFramework": "net8.0"
}
}
],
"build": {
Expand All @@ -129,17 +42,6 @@
"toc.yml"
]
},
{
// InteropHelpers project additional content, Includes the generated metadata API folder
"files": [
"interop-helpers/**.{md,yml}"
],
// Exclude the namespace overwrites and XREF maps as they are listed explicitly elsewhere
"exclude": [
"**/namespaces/**.md",
"**/*-xref.yml"
]
},
{
// Pull in the LLVM samples as content. The LLVM core project is more complex in the docfx.json as it
// includes the samples but they are NOT participating in metadata generation. They only contribute
Expand All @@ -159,39 +61,6 @@
"**/ReadMe.md"
]
},
{
// ANTLR Utils project additional content, Includes the generated metadata API folder
"files": [
"antlr-utils/**.{md,yml}"
],
// Exclude the namespace overwrites and XREF maps as they are listed explicitly elsewhere
"exclude": [
"**/namespaces/**.md",
"**/*-xref.yml"
]
},
{
// CommandLine Utils project additional content, Includes the generated metadata API folder
"files": [
"CommandLine/**.{md,yml}"
],
// Exclude the namespace overwrites and XREF maps as they are listed explicitly elsewhere
"exclude": [
"**/namespaces/**.md",
"**/*-xref.yml"
]
},
{
// extensions project additional content, Includes the generated metadata API folder
"files": [
"extensions/**.{md,yml}"
],
// Exclude the namespace overwrites and XREF maps as they are listed explicitly elsewhere
"exclude": [
"**/namespaces/**.md",
"**/*-xref.yml"
]
},
{
// LLVM project additional content, Includes the generated metadata API folder
"files": [
Expand All @@ -202,30 +71,6 @@
"**/namespaces/**.md",
"**/*-xref.yml"
]
},
{
// Runtime Utils project additional content, Includes the generated metadata API folder
// NOTE: File paths are relative to the location of this file
"files": [
"runtime-utils/**.{md,yml}"
],
// Exclude the namespace overwrites and XREF maps as they are listed explicitly elsewhere
"exclude": [
"**/namespaces/**.md",
"**/*-xref.yml"
]
},
{
// SrcGenerations project additional content, Includes the generated metadata API folder
// NOTE: File paths are relative to the location of this file
"files": [
"SrcGeneration/**.{md,yml}"
],
// Exclude the namespace overwrites and XREF maps as they are listed explicitly elsewhere
"exclude": [
"**/namespaces/**.md",
"**/*-xref.yml"
]
}
],
"resource": [
Expand Down
8 changes: 0 additions & 8 deletions docfx/documentation.msbuildproj
Original file line number Diff line number Diff line change
Expand Up @@ -33,25 +33,21 @@
<!--Everything in the runtime-utils sub-folders except the API folder as that contains generated files -->
<None Include="runtime-utils/**" Exclude="runtime-utils/api/**" />
<!-- Explicitly call out the non-generated files in the API folder-->
<None Include="runtime-utils/api/index.md" />
</ItemGroup>
<ItemGroup>
<!--Everything in the extensions sub-folders except the API folder as that contains generated files -->
<None Include="extensions/**" Exclude="extensions/api/**" />
<!-- Explicitly call out the non-generated files in the API folder-->
<None Include="extensions/api/index.md" />
</ItemGroup>
<ItemGroup>
<!--Everything in the antlr-utils sub-folders except the API folder as that contains generated files -->
<None Include="antlr-utils/**" Exclude="antlr-utils/api/**" />
<!-- Explicitly call out the non-generated files in the API folder-->
<None Include="antlr-utils/api/index.md" />
</ItemGroup>
<ItemGroup>
<!--Everything in the interop-helpers sub-folders except the API folder as that contains generated files -->
<None Include="interop-helpers/**" Exclude="interop-helpers/api/**" />
<!-- Explicitly call out the non-generated files in the API folder-->
<None Include="interop-helpers/api/index.md" />
</ItemGroup>
<ItemGroup>
<!--Everything in the TextUX sub-folders except the API folder as that contains generated files -->
Expand All @@ -62,16 +58,12 @@
<!--Everything in the CommandLine sub-folders except the API folder as that contains generated files -->
<None Include="CommandLine/**" Exclude="CommandLine/api/**" />
<!-- Explicitly call out the non-generated files in the API folder-->
<None Include="CommandLine/api/index.md" />
</ItemGroup>

<ItemGroup>
<!--Everything in the SrcGeneration sub-folders except the API folder as that contains generated files -->
<None Include="SrcGeneration/**" Exclude="SrcGeneration/api/**" />
<!-- Explicitly call out the non-generated files in the API folder-->
<None Include="SrcGeneration/api/index.md" />
</ItemGroup>

<Target Name="AlwaysRun" BeforeTargets="AfterBuild">
<Message Importance="High" Text="NOTE: Building $(MSBuildProjectFile) does NOTHING, docs are built using the docfx tool. This project is simply a convenient placeholder for organizing/editing files" />
</Target>
Expand Down
5 changes: 0 additions & 5 deletions docfx/extensions/api/.gitignore

This file was deleted.

32 changes: 0 additions & 32 deletions docfx/extensions/api/index.md

This file was deleted.

32 changes: 0 additions & 32 deletions docfx/extensions/index.md

This file was deleted.

Loading
Loading