Skip to content

Commit 5dad2a5

Browse files
committed
Update docfx, run as .NET tool instead of choco
1 parent 714b09a commit 5dad2a5

File tree

4 files changed

+11
-14
lines changed

4 files changed

+11
-14
lines changed

.config/dotnet-tools.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@
2525
"commands": [
2626
"reportgenerator"
2727
]
28+
},
29+
"docfx": {
30+
"version": "2.60.2",
31+
"commands": [
32+
"docfx"
33+
]
2834
}
2935
}
3036
}

appveyor.yml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,11 @@ for:
4545
# https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html
4646
git checkout $env:APPVEYOR_REPO_BRANCH -q
4747
}
48-
choco install docfx -y
49-
if ($lastexitcode -ne 0) {
50-
throw "docfx install failed with exit code $lastexitcode."
51-
}
5248
after_build:
5349
- pwsh: |
5450
CD ./docs
5551
& ./generate-examples.ps1
56-
& docfx docfx.json
52+
& dotnet docfx docfx.json
5753
if ($lastexitcode -ne 0) {
5854
throw "docfx build failed with exit code $lastexitcode."
5955
}

docs/README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,7 @@ Documentation for JsonApiDotNetCore is produced using [DocFX](https://dotnet.git
33
In addition, the example request/response pairs are generated by executing `curl` commands against the GettingStarted project.
44

55
# Installation
6-
Run the following commands once to setup your system:
7-
8-
```
9-
choco install docfx -y
10-
```
6+
Run the following command once to setup your system:
117

128
```
139
npm install -g httpserver

docs/build-dev.ps1

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
#Requires -Version 7.0
22

33
# This script builds the documentation website, starts a web server and opens the site in your browser. Intended for local development.
4-
# It is assumed that you have already installed docfx and httpserver.
5-
# If that's not the case, run the next commands:
6-
# choco install docfx -y
4+
# It is assumed that you have already installed httpserver.
5+
# If that's not the case, run the next command:
76
# npm install -g httpserver
87

98
param(
@@ -26,7 +25,7 @@ if (-Not $NoBuild -Or -Not (Test-Path -Path _site)) {
2625
Invoke-Expression ./generate-examples.ps1
2726
}
2827

29-
docfx ./docfx.json
28+
dotnet docfx ./docfx.json
3029
VerifySuccessExitCode
3130

3231
Copy-Item -Force home/*.html _site/

0 commit comments

Comments
 (0)