Use new docs build

benjamin-hodgson · Sep 12, 2023 · 0ec7529 · 0ec7529
1 parent 78c318f
commit 0ec7529
Show file tree

Hide file tree

Showing 11 changed files with 51 additions and 40 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -8,12 +8,13 @@ on:
   pull_request:
     branches: [ main ]
   workflow_dispatch:
-  
+
 
 jobs:
   build:
     uses: benjamin-hodgson/BuildScripts/.github/workflows/dotnet.yml@main
     with:
       DOCS_FOLDER: Pidgin.Docs
+      USE_NEW_DOCS: true
     secrets:
       NUGET_KEY: ${{ secrets.NUGET_KEY }}
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -11,6 +11,7 @@
 
         <Nullable>enable</Nullable>
 
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
         <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)Pidgin.snk</AssemblyOriginatorKeyFile>
 
         <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>

diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -13,7 +13,7 @@
     </ItemGroup>
 
     <ItemGroup>
-        <GlobalPackageReference Include="Benjamin.Pizza.BuildScripts" Version="2.1.0" />
+        <GlobalPackageReference Include="Benjamin.Pizza.BuildScripts" Version="2.2.2" />
         <GlobalPackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" />
         <GlobalPackageReference Include="StyleCop.Analyzers" Version="1.1.118" />
     </ItemGroup>

diff --git a/Pidgin.BuildTool.props b/Pidgin.BuildTool.props
@@ -2,7 +2,7 @@
     <PropertyGroup>
         <TargetFramework>net7.0</TargetFramework>
         <IsPackable>false</IsPackable>
-        <NoWarn>$(NoWarn);SA0001</NoWarn>
+        <NoWarn>$(NoWarn);CS1591</NoWarn>
         <RollForward>major</RollForward>
     </PropertyGroup>
 </Project>
diff --git a/Pidgin.Docs/.gitignore b/Pidgin.Docs/.gitignore
diff --git a/Pidgin.Docs/Pidgin.Docs.proj b/Pidgin.Docs/Pidgin.Docs.proj
@@ -0,0 +1,17 @@
+<Project Sdk="Microsoft.Build.NoTargets">
+
+    <Import Project="../Pidgin.BuildTool.props" />
+
+    <PropertyGroup>
+        <IsDocumentationProject>true</IsDocumentationProject>
+        <DocumentationSiteTitle>Pidgin</DocumentationSiteTitle>
+        <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <ProjectReference Include="../Pidgin/Pidgin.csproj">
+            <OutputItemType>DocumentationAssembly</OutputItemType>
+        </ProjectReference>
+    </ItemGroup>
+
+</Project>
diff --git a/Pidgin.Docs/docfx.json b/Pidgin.Docs/docfx.json
diff --git a/Pidgin.Docs/index.md b/Pidgin.Docs/index.md
diff --git a/Pidgin.sln b/Pidgin.sln
@@ -15,6 +15,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Pidgin.Examples", "Pidgin.E
 EndProject
 Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "Pidgin.Bench.FParsec", "Pidgin.Bench.FParsec\Pidgin.Bench.FParsec.fsproj", "{6E014557-0C35-47B7-B1CC-FE2ECB8D7423}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Pidgin.Docs", "Pidgin.Docs\Pidgin.Docs.proj", "{07F0778E-F59E-471A-9B10-1D6D9C386EE6}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -97,6 +99,18 @@ Global
 		{6E014557-0C35-47B7-B1CC-FE2ECB8D7423}.Release|x64.Build.0 = Release|x64
 		{6E014557-0C35-47B7-B1CC-FE2ECB8D7423}.Release|x86.ActiveCfg = Release|x86
 		{6E014557-0C35-47B7-B1CC-FE2ECB8D7423}.Release|x86.Build.0 = Release|x86
+		{07F0778E-F59E-471A-9B10-1D6D9C386EE6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{07F0778E-F59E-471A-9B10-1D6D9C386EE6}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{07F0778E-F59E-471A-9B10-1D6D9C386EE6}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{07F0778E-F59E-471A-9B10-1D6D9C386EE6}.Debug|x64.Build.0 = Debug|Any CPU
+		{07F0778E-F59E-471A-9B10-1D6D9C386EE6}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{07F0778E-F59E-471A-9B10-1D6D9C386EE6}.Debug|x86.Build.0 = Debug|Any CPU
+		{07F0778E-F59E-471A-9B10-1D6D9C386EE6}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{07F0778E-F59E-471A-9B10-1D6D9C386EE6}.Release|Any CPU.Build.0 = Release|Any CPU
+		{07F0778E-F59E-471A-9B10-1D6D9C386EE6}.Release|x64.ActiveCfg = Release|Any CPU
+		{07F0778E-F59E-471A-9B10-1D6D9C386EE6}.Release|x64.Build.0 = Release|Any CPU
+		{07F0778E-F59E-471A-9B10-1D6D9C386EE6}.Release|x86.ActiveCfg = Release|Any CPU
+		{07F0778E-F59E-471A-9B10-1D6D9C386EE6}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

diff --git a/dotnet-tools.json b/dotnet-tools.json
@@ -0,0 +1,12 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "docfx": {
+      "version": "2.70.3",
+      "commands": [
+        "docfx"
+      ]
+    }
+  }
+}
diff --git a/global.json b/global.json
@@ -2,5 +2,8 @@
     "sdk": {
         "version": "7.0.100",
         "rollForward": "latestMajor"
+    },
+    "msbuild-sdks": {
+        "Microsoft.Build.NoTargets": "3.7.0"
     }
 }