Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 354b291

Browse files
committed
build docs with fsdocs
1 parent ef1b01b commit 354b291

File tree

4 files changed

+64
-7
lines changed

4 files changed

+64
-7
lines changed

.github/workflows/docs.yml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,20 @@ jobs:
2424
run: dotnet tool restore
2525
- name: Restore dependencies
2626
run: dotnet paket restore
27-
- name: Run Fornax
28-
run: dotnet fsdocs build
27+
- name: Checkout fsharp master
28+
run: git clone https://github.com/dotnet/fsharp --depth 1 fsharp
29+
- name: Build fsharp master
30+
run: cd fsharp && .\build
31+
- name: Checkout FSharp.Formatting master
32+
run: git clone https://github.com/dotnet/FSharp.Formatting --depth 1 FSharp.Formatting
33+
- name: Build FSharp.Formatting master
34+
run: cd FSharp.Formatting && .\build
35+
- name: Run fsdocs
36+
run: FSharp.Formatting\src\FSharp.Formatting.CommandTool\bin\Release\netcoreapp3.1\fsdocs.exe build --sourcefolder fsharp
2937
- name: Deploy
3038
uses: peaceiris/actions-gh-pages@v3
3139
with:
3240
personal_token: ${{ secrets.GITHUB_TOKEN }}
33-
publish_dir: ./otuput
41+
publish_dir: ./output
3442
publish_branch: gh-pages
3543
force_orphan: true

FSharp.Core/FSharp.Core.fsproj

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<Project Sdk="Microsoft.NET.Sdk">
3+
<PropertyGroup>
4+
<TargetFramework>netstandard2.0</TargetFramework>
5+
<Authors>F# Software Foundation; Microsoft; F# Contributors</Authors>
6+
<Summary>The core library for F#</Summary>
7+
<Description>The core library F#</Description>
8+
<Copyright>Copyright 2003-2020</Copyright>
9+
<PackageLicenseUrl>https://github.com/dotnet/fsharp/blob/master/License.txt</PackageLicenseUrl>
10+
<PackageProjectUrl>https://github.com/fsharp/fsharp-core-api-docs/</PackageProjectUrl>
11+
<PackageIconUrl>https://fsharp.org/img/logo/fsharp128.png</PackageIconUrl>
12+
<PackageTags>F#;async;fsharp;streaming</PackageTags>
13+
<IncludeSymbols>true</IncludeSymbols>
14+
<RepositoryUrl>https://github.com/dotnet/fsharp/</RepositoryUrl>
15+
<RepositoryType>git</RepositoryType>
16+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
17+
<OutputType>Library</OutputType>
18+
<IsTestProject>false</IsTestProject>
19+
<IsPackable>true</IsPackable>
20+
<PackageLicenseExpression>MIT</PackageLicenseExpression>
21+
<PackageVersion>4.7.2</PackageVersion>
22+
<DisableImplicitFSharpCoreReference>true</DisableImplicitFSharpCoreReference>
23+
<!-- <TargetPath>$(MSBuildThisFileDirectory)..\packages\FSharp.Core\lib\netstandard2.0\FSharp.Core.dll</TargetPath> -->
24+
25+
<!-- for a parallel checkout and build of fsharp -->
26+
<TargetPath Condition="Exists('..\..\fsharp\build.cmd')">$(MSBuildThisFileDirectory)..\..\fsharp\artifacts\bin\FSharp.Core\Debug\netstandard2.0\FSharp.Core.dll</TargetPath>
27+
28+
<!-- for a local checkout and build of fsharp in CI -->
29+
<TargetPath Condition="Exists('..\fsharp\build.cmd')">$(MSBuildThisFileDirectory)..\fsharp\artifacts\bin\FSharp.Core\Debug\netstandard2.0\FSharp.Core.dll</TargetPath>
30+
</PropertyGroup>
31+
</Project>
32+

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,28 @@
22

33
https://fsharp.github.io/fsharp-core-api-docs/
44

5-
## Build steps:
5+
## Build steps
6+
7+
Have a build of https://github.com/dotnet/fsharp in a parallel directory, e.g.
8+
9+
git clone https://github.com/dotnet/fsharp --depth 1
10+
cd fsharp
11+
.\build
12+
13+
Then
14+
15+
dotnet tool restore
16+
dotnet paket restore
17+
dotnet fsdocs build --sourcefolder ../fsharp
18+
19+
For iterative development use:
20+
21+
dotnet fsdocs watch --sourcefolder ../fsharp --open reference/index.html
22+
23+
Change the `TargetPath` in our local `FSharp.Core.fsproj` if needed to picl up a different build of FSHarp.Core.
24+
25+
<TargetPath>$(MSBuildThisFileDirectory)..\..\fsharp\artifacts\bin\FSharp.Core\Debug\netstandard2.0\FSharp.Core.dll</TargetPath>
626

7-
* dotnet tool restore
8-
* dotnet paket restore
9-
* dotnet fsdocs build --sourcefolder F:/workspace/_work/1/s/
1027

1128
## CI Pipeline
1229

docs/img/logo.png

3.25 KB
Loading

0 commit comments

Comments
 (0)