Skip to content

Commit

Permalink
[Doc] Upgrade to Docfx 2.67.0 (#6738)
Browse files Browse the repository at this point in the history
* [Doc] Upgrade to `Docfx 2.67.0`
- remove `docfx.console`

* `docfx.exe` to `docfx`

* fix

* fix

* fixed - removed `--warningsAsErrors`

* fix

* fix - $VisualStudioVersion = "17.5.0"

* Add `"warningsAsErrors": true` to `Docfx.json`
  • Loading branch information
eaba authored May 9, 2023
1 parent 95b6227 commit 66f348a
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 18 deletions.
5 changes: 2 additions & 3 deletions build.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -488,14 +488,13 @@ Target "DocFx" (fun _ ->
{ p with
ExcludeVersion = true
Version = "0.1.0-alpha-1611021200"
OutputDirectory = currentDirectory @@ "tools" }) "msdn.4.5.2"
OutputDirectory = currentDirectory @@ "tools" }) "msdn.4.5.2"

let docsPath = FullName "./docs"
let docFxPath = FullName(findToolInSubPath "docfx.exe" "tools/docfx.console/tools")
let docFxPath = FullName(findToolInSubPath "docfx.exe" "tools/docfx/")

let args = StringBuilder()
|> append (docsPath @@ "docfx.json" )
|> append ("--warningsAsErrors")
|> toText

let result = ExecProcess(fun info ->
Expand Down
15 changes: 8 additions & 7 deletions build.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ $FakeVersion = "4.63.0"
$NugetVersion = "5.8.0";
$NugetUrl = "https://dist.nuget.org/win-x86-commandline/v$NugetVersion/nuget.exe"
$ProtobufVersion = "3.21.5"
$DocfxVersion = "2.59.4"
$DocfxVersion = "2.67.0"

$IncrementalistVersion = "0.8.0";

Expand Down Expand Up @@ -89,13 +89,14 @@ if (!(Test-Path $ProtobufExePath)) {
###########################################################################

# Make sure Docfx has been installed.
$DocfxExePath = Join-Path $ToolPath "docfx.console/tools/docfx.exe"
if (!(Test-Path $DocfxExePath)) {
# Make sure the Incrementalist has been installed
if (Get-Command docfx -ErrorAction SilentlyContinue) {
Write-Host "Found docfx. Skipping install."
}
else{
$DocfxExePath = Join-Path $ToolPath "docfx"
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."
}
dotnet tool install docfx --version $DocfxVersion --tool-path "$DocfxExePath"
}

###########################################################################
Expand Down
8 changes: 5 additions & 3 deletions docs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"**/*Tests*.csproj",
"**/*Tests.*.csproj"
],
"src": "../src"
"cwd": "../src"
}],
"dest": "api",
"filter": "filterConfig.yml"
Expand All @@ -23,7 +23,7 @@
"files": [
"api/**.yml",
"api/index.md"
]
]
}, {
"files": [
"articles/**.md",
Expand Down Expand Up @@ -77,6 +77,8 @@
"template"
],
"postProcessors": ["ExtractSearchIndex"],
"noLangKeyword": false
"noLangKeyword": false,
"warningsAsErrors": true,
"Docfx_Git_Timeout": 30000
}
}
6 changes: 3 additions & 3 deletions serve-docs.ps1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# docfx.ps1
$VisualStudioVersion = "15.0";
$DotnetSDKVersion = "2.0.0";
$VisualStudioVersion = "17.5.0";
$DotnetSDKVersion = "7.0.203";

# Get dotnet paths
$MSBuildExtensionsPath = "C:\Program Files\dotnet\sdk\" + $DotnetSDKVersion;
Expand All @@ -18,4 +18,4 @@ $env:MSBuildExtensionsPath = $MSBuildExtensionsPath;
$env:MSBuildSDKsPath = $MSBuildSDKsPath;

# Build our docs
& .\tools\docfx.console\tools\docfx @args
& .\tools\docfx\docfx @args
4 changes: 2 additions & 2 deletions src/Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<PropertyGroup>
<Copyright>Copyright © 2013-2023 Akka.NET Team</Copyright>
<Authors>Akka.NET Team</Authors>
<VersionPrefix>1.5.4</VersionPrefix>
<VersionPrefix>1.5.7</VersionPrefix>
<PackageIcon>akkalogo.png</PackageIcon>
<PackageProjectUrl>https://github.com/akkadotnet/akka.net</PackageProjectUrl>
<PackageLicenseUrl>https://github.com/akkadotnet/akka.net/blob/master/LICENSE</PackageLicenseUrl>
Expand Down Expand Up @@ -40,7 +40,7 @@
<CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
</PropertyGroup>
<PropertyGroup>
<PackageReleaseNotes>placeholder for nightlies*</PackageReleaseNotes>
<PackageReleaseNotes>Placeholder for nightlies*</PackageReleaseNotes>
</PropertyGroup>
<!-- SourceLink support for all Akka.NET projects -->
<ItemGroup>
Expand Down

0 comments on commit 66f348a

Please sign in to comment.