build: remove docfx (#157)

akkadotnet · Mar 12, 2023 · d6e7cf0 · d6e7cf0
1 parent cd969de
commit d6e7cf0
Show file tree

Hide file tree

Showing 14 changed files with 4 additions and 170 deletions.
diff --git a/README.md b/README.md
@@ -432,24 +432,6 @@ The attached build script will automatically do the following based on the conve
 * Any project name ending with `.Tests` will automatically be treated as a [NBench](https://github.com/petabridge/NBench) project and will be included during the test stages of this build script; and
 * Any project meeting neither of these conventions will be treated as a NuGet packaging target and its `.nupkg` file will automatically be placed in the `bin\nuget` folder upon running the `build.[cmd|sh] all` command.
 
-### DocFx for Documentation
-
-This solution also supports [DocFx](http://dotnet.github.io/docfx/) for generating both API documentation and articles to describe the behavior, output, and usages of your project.
-
-All of the relevant articles you wish to write should be added to the `/docs/articles/` folder and any API documentation you might need will also appear there.
-
-All of the documentation will be statically generated and the output will be placed in the `/docs/_site/` folder.
-
-#### Previewing Documentation
-
-To preview the documentation for this project, execute the following command at the root of this folder:
-
-```
-C:\> serve-docs.cmd
-```
-
-This will use the built-in `docfx.console` binary that is installed as part of the NuGet restore process from executing any of the usual `build.cmd` or `build.sh` steps to preview the fully-rendered documentation. For best results, do this immediately after calling `build.cmd buildRelease`.
-
 ### Release Notes, Version Numbers, Etc
 
 This project will automatically populate its release notes in all of its modules via the entries written inside [`RELEASE_NOTES.md`](RELEASE_NOTES.md) and will automatically update the versions of all assemblies and NuGet packages via the metadata included inside [`Directory.Build.props`](src/Directory.Build.props).
diff --git a/build.fsx b/build.fsx
@@ -7,7 +7,6 @@ open System.Text
 
 open Fake
 open Fake.DotNetCli
-open Fake.DocFxHelper
 
 // Information about the project for Nuget and Assembly info files
 let configuration = "Release"
@@ -47,7 +46,6 @@ Target "Clean" (fun _ ->
     CleanDir outputTests
     CleanDir outputPerfTests
     CleanDir outputNuGet
-    CleanDir "docs/_site"
 )
 
 Target "AssemblyInfo" (fun _ ->
@@ -177,22 +175,6 @@ Target "PublishNuget" (fun _ ->
         projects |> Seq.iter (runSingleProject)
 )
 
-//--------------------------------------------------------------------------------
-// Documentation
-//--------------------------------------------------------------------------------
-Target "DocFx" (fun _ ->
-    DotNetCli.Restore (fun p -> { p with Project = solutionFile })
-    DotNetCli.Build (fun p -> { p with Project = solutionFile; Configuration = configuration })
-
-    let docsPath = "./docs"
-
-    DocFx (fun p ->
-                { p with
-                    Timeout = TimeSpan.FromMinutes 30.0;
-                    WorkingDirectory  = docsPath;
-                    DocFxJson = docsPath @@ "docfx.json" })
-)
-
 //--------------------------------------------------------------------------------
 // Cleanup
 //--------------------------------------------------------------------------------
@@ -218,7 +200,6 @@ Target "Help" <| fun _ ->
       " * Nuget         Create and optionally publish nugets packages"
       " * RunTests      Runs tests"
       " * All           Builds, run tests, creates and optionally publish nuget packages"
-      " * DocFx         Creates a DocFx-based website for this solution"
       ""
       " Other Targets"
       " * Help       Display this help"
@@ -241,9 +222,6 @@ Target "Nuget" DoNothing
 "Clean" ==> "Build" ==> "CreateNuget"
 "CreateNuget" ==> "PublishNuget" ==> "Nuget"
 
-// docs
-"Clean" ==> "BuildRelease" ==> "Docfx"
-
 // all
 "BuildRelease" ==> "All"
 "RunTests" ==> "All"

diff --git a/build.ps1 b/build.ps1
@@ -32,7 +32,6 @@ Param(
 $FakeVersion = "4.63.0"
 $NugetVersion = "5.8.0"
 $NugetUrl = "https://dist.nuget.org/win-x86-commandline/v$NugetVersion/nuget.exe"
-$DocfxVersion = "2.58.9"
 
 # Make sure tools folder exists
 $PSScriptRoot = Split-Path $MyInvocation.MyCommand.Path -Parent
@@ -67,20 +66,6 @@ if (!(Test-Path $FakeExePath)) {
     }
 }
 
-###########################################################################
-# Docfx
-###########################################################################
-
-# Make sure Docfx has been installed.
-$DocfxExePath = Join-Path $ToolPath "docfx.console/tools/docfx.exe"
-if (!(Test-Path $DocfxExePath)) {
-    Write-Host "Installing Docfx..."
-    Invoke-Expression "&`"$NugetPath`" install docfx.console -ExcludeVersion -Version $DocfxVersion -OutputDirectory `"$ToolPath`"" | Out-Null;
-    if ($LASTEXITCODE -ne 0) {
-        Throw "An error occured while restoring docfx.console from NuGet."
-    }
-}
-
 ###########################################################################
 # RUN BUILD SCRIPT
 ###########################################################################

diff --git a/build.sh b/build.sh
@@ -10,8 +10,6 @@ NUGET_EXE=$TOOLS_DIR/nuget.exe
 NUGET_URL=https://dist.nuget.org/win-x86-commandline/v5.8.0/nuget.exe
 FAKE_VERSION=4.63.0
 FAKE_EXE=$TOOLS_DIR/FAKE/tools/FAKE.exe
-DOCFX_VERSION=2.58.9
-DOCFX_EXE=$TOOLS_DIR/docfx.console/tools/docfx.exe
 
 # Define default arguments.
 TARGET="Default"
@@ -70,23 +68,6 @@ if [ ! -f "$FAKE_EXE" ]; then
     exit 1
 fi
 
-###########################################################################
-# INSTALL DOCFX
-###########################################################################
-if [ ! -f "$DOCFX_EXE" ]; then
-    mono "$NUGET_EXE" install docfx.console -ExcludeVersion -Version $DOCFX_VERSION -OutputDirectory "$TOOLS_DIR"
-    if [ $? -ne 0 ]; then
-        echo "An error occured while installing DocFx."
-        exit 1
-    fi
-fi
-
-# Make sure that DocFx has been installed.
-if [ ! -f "$DOCFX_EXE" ]; then
-    echo "Could not find docfx.exe at '$DOCFX_EXE'."
-    exit 1
-fi
-
 ###########################################################################
 # WORKAROUND FOR MONO
 ###########################################################################

diff --git a/docs/api/index.md b/docs/api/index.md
diff --git a/docs/articles/index.md b/docs/articles/index.md
diff --git a/docs/articles/toc.yml b/docs/articles/toc.yml
diff --git a/docs/docfx.json b/docs/docfx.json
diff --git a/docs/images/icon.png b/docs/images/icon.png
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/toc.yml b/docs/toc.yml
diff --git a/docs/web.config b/docs/web.config
diff --git a/serve-docs.cmd b/serve-docs.cmd
diff --git a/src/Directory.Generated.props b/src/Directory.Generated.props
@@ -1,6 +1,7 @@
 <Project>
   <PropertyGroup>
-    <VersionPrefix>0.0.1</VersionPrefix>
-    <PackageReleaseNotes>Placeholder</PackageReleaseNotes>
+    <VersionPrefix>1.4.28</VersionPrefix>
+    <PackageReleaseNotes>Perf Enhancements and fixes to failure reporting**
+There was an issue found where persistence failures were being reported as rejections when they should not have. This has been fixed alongside some logic cleanup that should lead to more consistent performance.</PackageReleaseNotes>
   </PropertyGroup>
-</Project>
+</Project>