Skip to content

Commit 4a53e1c

Browse files
committed
Revert "[Doc] Upgrade to Docfx 2.67.0 (akkadotnet#6738)"
This reverts commit 66f348a.
1 parent c1a273c commit 4a53e1c

File tree

5 files changed

+18
-20
lines changed

5 files changed

+18
-20
lines changed

build.fsx

+3-2
Original file line numberDiff line numberDiff line change
@@ -488,13 +488,14 @@ Target "DocFx" (fun _ ->
488488
{ p with
489489
ExcludeVersion = true
490490
Version = "0.1.0-alpha-1611021200"
491-
OutputDirectory = currentDirectory @@ "tools" }) "msdn.4.5.2"
491+
OutputDirectory = currentDirectory @@ "tools" }) "msdn.4.5.2"
492492

493493
let docsPath = FullName "./docs"
494-
let docFxPath = FullName(findToolInSubPath "docfx.exe" "tools/docfx/")
494+
let docFxPath = FullName(findToolInSubPath "docfx.exe" "tools/docfx.console/tools")
495495

496496
let args = StringBuilder()
497497
|> append (docsPath @@ "docfx.json" )
498+
|> append ("--warningsAsErrors")
498499
|> toText
499500

500501
let result = ExecProcess(fun info ->

build.ps1

+7-8
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ $FakeVersion = "4.63.0"
3333
$NugetVersion = "5.8.0";
3434
$NugetUrl = "https://dist.nuget.org/win-x86-commandline/v$NugetVersion/nuget.exe"
3535
$ProtobufVersion = "3.21.5"
36-
$DocfxVersion = "2.67.0"
36+
$DocfxVersion = "2.59.4"
3737

3838
$IncrementalistVersion = "0.8.0";
3939

@@ -89,14 +89,13 @@ if (!(Test-Path $ProtobufExePath)) {
8989
###########################################################################
9090

9191
# Make sure Docfx has been installed.
92-
# Make sure the Incrementalist has been installed
93-
if (Get-Command docfx -ErrorAction SilentlyContinue) {
94-
Write-Host "Found docfx. Skipping install."
95-
}
96-
else{
97-
$DocfxExePath = Join-Path $ToolPath "docfx"
92+
$DocfxExePath = Join-Path $ToolPath "docfx.console/tools/docfx.exe"
93+
if (!(Test-Path $DocfxExePath)) {
9894
Write-Host "Installing Docfx..."
99-
dotnet tool install docfx --version $DocfxVersion --tool-path "$DocfxExePath"
95+
Invoke-Expression "&`"$NugetPath`" install docfx.console -ExcludeVersion -Version $DocfxVersion -OutputDirectory `"$ToolPath`"" | Out-Null;
96+
if ($LASTEXITCODE -ne 0) {
97+
Throw "An error occured while restoring docfx.console from NuGet."
98+
}
10099
}
101100

102101
###########################################################################

docs/docfx.json

+3-5
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"**/*Tests*.csproj",
1414
"**/*Tests.*.csproj"
1515
],
16-
"cwd": "../src"
16+
"src": "../src"
1717
}],
1818
"dest": "api",
1919
"filter": "filterConfig.yml"
@@ -23,7 +23,7 @@
2323
"files": [
2424
"api/**.yml",
2525
"api/index.md"
26-
]
26+
]
2727
}, {
2828
"files": [
2929
"articles/**.md",
@@ -77,8 +77,6 @@
7777
"template"
7878
],
7979
"postProcessors": ["ExtractSearchIndex"],
80-
"noLangKeyword": false,
81-
"warningsAsErrors": true,
82-
"Docfx_Git_Timeout": 30000
80+
"noLangKeyword": false
8381
}
8482
}

serve-docs.ps1

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# docfx.ps1
2-
$VisualStudioVersion = "17.5.0";
3-
$DotnetSDKVersion = "7.0.203";
2+
$VisualStudioVersion = "15.0";
3+
$DotnetSDKVersion = "2.0.0";
44

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

2020
# Build our docs
21-
& .\tools\docfx\docfx @args
21+
& .\tools\docfx.console\tools\docfx @args

src/Directory.Build.props

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<PropertyGroup>
33
<Copyright>Copyright © 2013-2023 Akka.NET Team</Copyright>
44
<Authors>Akka.NET Team</Authors>
5-
<VersionPrefix>1.5.7</VersionPrefix>
5+
<VersionPrefix>1.5.4</VersionPrefix>
66
<PackageIcon>akkalogo.png</PackageIcon>
77
<PackageProjectUrl>https://github.com/akkadotnet/akka.net</PackageProjectUrl>
88
<PackageLicenseUrl>https://github.com/akkadotnet/akka.net/blob/master/LICENSE</PackageLicenseUrl>
@@ -40,7 +40,7 @@
4040
<CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
4141
</PropertyGroup>
4242
<PropertyGroup>
43-
<PackageReleaseNotes>Placeholder for nightlies*</PackageReleaseNotes>
43+
<PackageReleaseNotes>placeholder for nightlies*</PackageReleaseNotes>
4444
</PropertyGroup>
4545
<!-- SourceLink support for all Akka.NET projects -->
4646
<ItemGroup>

0 commit comments

Comments
 (0)