Skip to content

[Doc] Upgrade to Docfx 2.67.0 #6738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
May 9, 2023
Merged

[Doc] Upgrade to Docfx 2.67.0 #6738

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
b1c55e2
[Doc] Upgrade to `Docfx 2.67.0`
eaba May 7, 2023
9552b60
Merge branch 'dev' into doc_fx
eaba May 7, 2023
e7fb676
`docfx.exe` to `docfx`
eaba May 7, 2023
558a3f1
Merge branch 'doc_fx' of https://github.com/eaba/akka.net into doc_fx
eaba May 7, 2023
64bccf7
fix
eaba May 7, 2023
d598251
fix
eaba May 8, 2023
92d05d8
Merge branch 'dev' into doc_fx
eaba May 8, 2023
4c672f2
fixed - removed `--warningsAsErrors`
eaba May 9, 2023
71ac1b3
fix
eaba May 9, 2023
aba9f20
Merge branch 'dev' into doc_fx
eaba May 9, 2023
99b36c3
fix - $VisualStudioVersion = "17.5.0"
eaba May 9, 2023
17538e6
Add `"warningsAsErrors": true` to `Docfx.json`
eaba May 9, 2023
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
5 changes: 2 additions & 3 deletions build.fsx
View file
Open in desktop
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
View file
Open in desktop
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"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docfx 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"
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dotnet tool install


###########################################################################
Expand Down
8 changes: 5 additions & 3 deletions docs/docfx.json
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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