Skip to content

Commit c00a01e

Browse files
nojafnojaf
authored
chore: Update to fsdocs (#200)
* chore: Update to fsdocs * Remove Cyclic dependency
1 parent 084a6d1 commit c00a01e

File tree

7 files changed

+37
-115
lines changed

7 files changed

+37
-115
lines changed

‎.config/dotnet-tools.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
"sourcelink"
2121
]
2222
},
23-
"fsharp.formatting.commandtool": {
24-
"version": "7.2.9",
23+
"fsdocs-tool": {
24+
"version": "20.0.0-alpha-016",
2525
"commands": [
2626
"fsdocs"
2727
]

‎.github/workflows/release.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,17 @@ jobs:
3131
env:
3232
NUGET_KEY: ${{ secrets.NUGET_KEY }}
3333
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
34+
# Upload the static files
35+
- name: Upload documentation
36+
uses: actions/upload-pages-artifact@v2
37+
with:
38+
path: ./output
39+
40+
# GitHub Actions recommends deploying in a separate job.
41+
DeployDocs:
42+
runs-on: ubuntu-latest
43+
needs: Release
44+
steps:
45+
- name: Deploy to GitHub Pages
46+
id: deployment
47+
uses: actions/deploy-pages@v2

‎Argu.sln‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,33 @@ Microsoft Visual Studio Solution File, Format Version 12.00
22
# Visual Studio 15
33
VisualStudioVersion = 15.0.27428.2002
44
MinimumVisualStudioVersion = 10.0.40219.1
5-
Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Argu", "src\Argu\Argu.fsproj", "{D3E958F9-5FFF-462E-BDC7-A03272A9F5D9}"
5+
Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Argu", "src\Argu\Argu.fsproj", "{D3E958F9-5FFF-462E-BDC7-A03272A9F5D9}"
66
EndProject
7-
Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Argu.Samples.LS", "samples\Argu.Samples.LS\Argu.Samples.LS.fsproj", "{E0563A30-4451-4DF2-9D21-26C76EB85C22}"
7+
Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Argu.Samples.LS", "samples\Argu.Samples.LS\Argu.Samples.LS.fsproj", "{E0563A30-4451-4DF2-9D21-26C76EB85C22}"
88
EndProject
9-
Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Argu.Tests", "tests\Argu.Tests\Argu.Tests.fsproj", "{8E234746-5098-4400-98F1-62C77AB91711}"
9+
Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Argu.Tests", "tests\Argu.Tests\Argu.Tests.fsproj", "{8E234746-5098-4400-98F1-62C77AB91711}"
1010
EndProject
11-
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".config", ".config", "{6CAC8891-E2B6-4CC8-AACF-0AAA4F2A49D0}"
11+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".config", ".config", "{6CAC8891-E2B6-4CC8-AACF-0AAA4F2A49D0}"
1212
ProjectSection(SolutionItems) = preProject
1313
.config\dotnet-tools.json = .config\dotnet-tools.json
1414
EndProjectSection
1515
EndProject
16-
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".github", ".github", "{83FE66F8-6E59-4178-8962-11117B51F39C}"
16+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".github", ".github", "{83FE66F8-6E59-4178-8962-11117B51F39C}"
1717
ProjectSection(SolutionItems) = preProject
1818
.github\ISSUE_TEMPLATE.md = .github\ISSUE_TEMPLATE.md
1919
EndProjectSection
2020
EndProject
21-
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{EE42293D-9398-4EF4-B151-9DE992EBB85A}"
21+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{EE42293D-9398-4EF4-B151-9DE992EBB85A}"
2222
ProjectSection(SolutionItems) = preProject
2323
.github\workflows\build.yml = .github\workflows\build.yml
2424
EndProjectSection
2525
EndProject
26-
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".paket", ".paket", "{306D68AD-1E01-4367-9498-EF4CEDE0AF38}"
26+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".paket", ".paket", "{306D68AD-1E01-4367-9498-EF4CEDE0AF38}"
2727
ProjectSection(SolutionItems) = preProject
2828
.paket\Paket.Restore.targets = .paket\Paket.Restore.targets
2929
EndProjectSection
3030
EndProject
31-
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{2687163A-E0EA-4EC6-A388-430314AA8C85}"
31+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{2687163A-E0EA-4EC6-A388-430314AA8C85}"
3232
ProjectSection(SolutionItems) = preProject
3333
.dockerignore = .dockerignore
3434
.gitignore = .gitignore
@@ -50,30 +50,29 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
5050
RELEASE_NOTES.md = RELEASE_NOTES.md
5151
EndProjectSection
5252
EndProject
53-
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{C9E28045-41C6-422E-9928-4220EF3FF19B}"
53+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{C9E28045-41C6-422E-9928-4220EF3FF19B}"
5454
ProjectSection(SolutionItems) = preProject
55-
docs\_template.html = docs\_template.html
5655
docs\index.fsx = docs\index.fsx
5756
docs\perf.fsx = docs\perf.fsx
5857
docs\tutorial.fsx = docs\tutorial.fsx
5958
EndProjectSection
6059
EndProject
61-
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "img", "img", "{10ED3503-22F2-42EF-8B35-C979A5B700D0}"
60+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "img", "img", "{10ED3503-22F2-42EF-8B35-C979A5B700D0}"
6261
ProjectSection(SolutionItems) = preProject
6362
docs\img\logo.pdn = docs\img\logo.pdn
6463
docs\img\logo.png = docs\img\logo.png
6564
EndProjectSection
6665
EndProject
67-
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "resource", "resource", "{B1E24C6F-9B2C-4102-B99A-9065B5745E6F}"
66+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "resource", "resource", "{B1E24C6F-9B2C-4102-B99A-9065B5745E6F}"
6867
ProjectSection(SolutionItems) = preProject
6968
resource\logo.png = resource\logo.png
7069
EndProjectSection
7170
EndProject
72-
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples", "samples", "{A15390A5-BC39-433F-BA25-8775B4C2E329}"
71+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples", "samples", "{A15390A5-BC39-433F-BA25-8775B4C2E329}"
7372
EndProject
74-
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{93AB3CBB-7714-49DD-9C6F-40E153A66E8F}"
73+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{93AB3CBB-7714-49DD-9C6F-40E153A66E8F}"
7574
EndProject
76-
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{E40F0B06-703E-4541-826F-3B8AED67AF7B}"
75+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{E40F0B06-703E-4541-826F-3B8AED67AF7B}"
7776
EndProject
7877
Global
7978
GlobalSection(SolutionConfigurationPlatforms) = preSolution

‎Directory.Build.props‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,10 @@
2121
<!--<IncludeSymbols>true</IncludeSymbols>-->
2222
<!--<SymbolPackageFormat>snupkg</SymbolPackageFormat>-->
2323
</PropertyGroup>
24+
25+
<!-- FsDocs -->
26+
<PropertyGroup>
27+
<FsDocsLicenseLink>https://github.com/fsprojects/Argu/blob/master/LICENSE.md</FsDocsLicenseLink>
28+
<FsDocsReleaseNotesLink>https://github.com/fsprojects/Argu/blob/master/RELEASE_NOTES.md</FsDocsReleaseNotesLink>
29+
</PropertyGroup>
2430
</Project>

‎build.fsx‎

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -123,21 +123,7 @@ Target.create "NuGet.Push" (fun _ ->
123123

124124
Target.create "GenerateDocs" (fun _ ->
125125
Shell.cleanDir ".fsdocs"
126-
DotNet.exec id "fsdocs" "build --clean --strict --property Configuration=Release" |> ignore
127-
)
128-
129-
Target.create "ReleaseDocs" (fun _ ->
130-
let tempDocsDir = "temp/gh-pages"
131-
let outputDocsDir = "output/"
132-
133-
Directory.ensure outputDocsDir
134-
135-
Shell.cleanDir tempDocsDir
136-
Git.Repository.cloneSingleBranch "" (gitHome + "/" + gitName + ".git") "gh-pages" tempDocsDir
137-
Shell.copyRecursive outputDocsDir tempDocsDir true |> Trace.tracefn "%A"
138-
Git.Staging.stageAll tempDocsDir
139-
Git.Commit.exec tempDocsDir (sprintf "Update generated documentation for version %s" release.NugetVersion)
140-
Git.Branches.push tempDocsDir
126+
DotNet.exec id "fsdocs" "build --clean --strict --properties Configuration=Release" |> ignore
141127
)
142128

143129
// Github Releases
@@ -203,7 +189,6 @@ Target.create "Release" ignore
203189
==> "Bundle"
204190

205191
"Bundle"
206-
==> "ReleaseDocs"
207192
==> "ReleaseGitHub"
208193
==> "NuGet.Push"
209194
==> "Release"

‎docs/_template.html‎

Lines changed: 0 additions & 82 deletions
This file was deleted.

‎docs/img/favicon.ico‎

162 KB
Binary file not shown.

0 commit comments

Comments
 (0)