Skip to content

Commit d4802cb

Browse files
Update fsdocs
1 parent 6e9698b commit d4802cb

File tree

7 files changed

+46
-65
lines changed

7 files changed

+46
-65
lines changed

.config/dotnet-tools.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
"isRoot": true,
44
"tools": {
55
"fsdocs-tool": {
6-
"version": "18.1.0",
6+
"version": "20.0.0",
77
"commands": [
88
"fsdocs"
9-
]
9+
],
10+
"rollForward": false
1011
}
1112
}
1213
}

.github/workflows/dotnet.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ jobs:
1010
runs-on: ubuntu-latest
1111

1212
steps:
13-
- uses: actions/checkout@v3
13+
- uses: actions/checkout@v4
1414
- name: Set up .NET
15-
uses: actions/setup-dotnet@v3
15+
uses: actions/setup-dotnet@v4
1616
with:
17-
dotnet-version: 7.x
17+
dotnet-version: 8.x
1818
- name: Restore dependencies
1919
run: dotnet restore
2020
- name: Build
@@ -29,11 +29,11 @@ jobs:
2929
runs-on: ubuntu-latest
3030

3131
steps:
32-
- uses: actions/checkout@v3
32+
- uses: actions/checkout@v4
3333
- name: Set up .NET
34-
uses: actions/setup-dotnet@v3
34+
uses: actions/setup-dotnet@v4
3535
with:
36-
dotnet-version: 7.x
36+
dotnet-version: 8.x
3737
env:
3838
NUGET_AUTH_TOKEN: ${{ secrets.NUGET_API_KEY }}
3939
- name: Pack

.github/workflows/github-pages.yml

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,45 +3,50 @@ name: Publish docs to GitHub Pages
33
on:
44
push:
55
branches: [ "main" ]
6-
6+
77
permissions:
8+
contents: read
89
pages: write
910
id-token: write
1011

12+
concurrency:
13+
group: "pages"
14+
cancel-in-progress: false
15+
1116
jobs:
1217
build-docs:
1318

1419
runs-on: ubuntu-latest
1520

1621
steps:
17-
- uses: actions/checkout@v3
22+
- uses: actions/checkout@v4
1823
- name: Set up .NET
19-
uses: actions/setup-dotnet@v3
24+
uses: actions/setup-dotnet@v4
2025
with:
21-
dotnet-version: 7.x
26+
dotnet-version: 8.x
2227
- name: Set up GitHub Pages
23-
uses: actions/configure-pages@v3
28+
uses: actions/configure-pages@v5
2429
- name: Restore dotnet tools
2530
run: dotnet tool restore
2631
- name: Restore dotnet projects
2732
run: dotnet restore
2833
- name: Build
29-
run: dotnet build ./FSharp.Collections.Builders/FSharp.Collections.Builders.fsproj -c Release -f net7.0
34+
run: dotnet build ./FSharp.Collections.Builders/FSharp.Collections.Builders.fsproj -c Release -f net8.0
3035
- name: Copy readme to docs folder
3136
run: cp README.md docs/index.md
3237
- name: Build docs
3338
run: |
3439
dotnet fsdocs build \
3540
--output ./out \
36-
--properties Configuration=Release TargetFramework=net7.0 \
41+
--properties Configuration=Release TargetFramework=net8.0 \
3742
--parameters \
3843
fsdocs-license-link https://github.com/brianrourkeboll/FSharp.Collections.Builders/blob/main/LICENSE.md \
3944
fsdocs-release-notes-link https://github.com/brianrourkeboll/FSharp.Collections.Builders/releases
4045
- name: Upload GitHub Pages artifact
41-
uses: actions/upload-pages-artifact@v1
46+
uses: actions/upload-pages-artifact@v3
4247
with:
4348
path: './out'
44-
49+
4550
publish-docs:
4651

4752
needs: build-docs
@@ -53,7 +58,7 @@ jobs:
5358
runs-on: ubuntu-latest
5459

5560
steps:
56-
- uses: actions/checkout@v3
61+
- uses: actions/checkout@v4
5762
- name: Deploy to GitHub Pages
5863
id: deployment
59-
uses: actions/deploy-pages@v1
64+
uses: actions/deploy-pages@v4

FSharp.Collections.Builders/FSharp.Collections.Builders.fsproj

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<Project Sdk="Microsoft.NET.Sdk">
22

33
<PropertyGroup>
4-
<TargetFrameworks>net6.0;net7.0</TargetFrameworks>
4+
<TargetFrameworks>net6.0;net8.0</TargetFrameworks>
55
<GenerateDocumentationFile>true</GenerateDocumentationFile>
66
<PackageId>FSharp.Collections.Builders</PackageId>
77
<Version>0.1.0-beta.2</Version>
@@ -16,7 +16,7 @@
1616
<PackageIcon>logo.png</PackageIcon>
1717
<IncludeSymbols>true</IncludeSymbols>
1818
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
19-
<Copyright2023 Brian Rourke Boll</Copyright>
19+
<Copyright2024 Brian Rourke Boll</Copyright>
2020
<!-- FS3390: XML documentation validation -->
2121
<!-- FS1182: Unused values -->
2222
<WarnOn>$(WarnOn);3390;1182</WarnOn>
@@ -47,8 +47,8 @@
4747
<PackageReference Update="FSharp.Core" Version="6.0.0" />
4848
</ItemGroup>
4949

50-
<ItemGroup Condition="'$(TargetFramework)' == 'net7.0'">
51-
<PackageReference Update="FSharp.Core" Version="7.0.0" />
50+
<ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
51+
<PackageReference Update="FSharp.Core" Version="8.0.100" />
5252
</ItemGroup>
5353

5454
</Project>

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ list, array, and sequence expressions, including `for`, `while`, `yield!`, `try`
2929
### `FSharp.Collections.Builders`
3030

3131
Open `FSharp.Collections.Builders` for type-inference-friendly builders that behave similarly to the built-in list,
32-
array, and sequence expressions in that they treat any collection used with `for` or `yield!` as a `seq<_>`.
32+
array, and sequence expressions in that they treat any collection used with `for` or `yield!` as a `_ seq`.
3333

3434
```fsharp
3535
open FSharp.Collections.Builders
@@ -70,13 +70,13 @@ let ys = resizeArray { for x in xs -> float x * 2.0 }
7070
let f xs = resizeArray { for x in xs do if x % 3 = 0 then x }
7171
```
7272
73-
> `xs` is `seq<int>`.
73+
> `xs` is `int seq`.
7474
7575
```fsharp
7676
let g xs = resizeArray<float> { for x in xs -> x * x }
7777
```
7878

79-
> `xs` is `seq<float>`.
79+
> `xs` is `float seq`.
8080
8181
### `hashSet`
8282

@@ -178,7 +178,7 @@ let m = map { for x in 1..100 -> x, x * x }
178178
> or
179179
>
180180
> ```fsharp
181-
> let m = (Map.empty, {1..100}) ||> Map.fold (fun m x -> m.Add (x, x * x))
181+
> let m = (Map.empty, {1..100}) ||> Seq.fold (fun m x -> m.Add (x, x * x))
182182
> ```
183183
184184
## Immutable collections from `System.Collections.Immutable`
@@ -269,7 +269,7 @@ let s =
269269
let s = sum { for x in xs do if x % 3 = 0 then x }
270270
```
271271

272-
The Greek capital letter sigma `Σ` (easily enterable via <kbd>⊞ Win</kbd> + <kbd>.</kbd> on Windows) may read better in certain domains:
272+
The Greek capital letter sigma `Σ` may read better in certain domains:
273273

274274
```fsharp
275275
Σ { for item in items -> item.Subtotal } <= 0.10 * total
@@ -308,7 +308,7 @@ let g xs =
308308
F#'s built-in [list](https://learn.microsoft.com/en-us/dotnet/fsharp/language-reference/lists#creating-and-initializing-lists),
309309
[array](https://learn.microsoft.com/en-us/dotnet/fsharp/language-reference/arrays#create-arrays),
310310
and [sequence](https://learn.microsoft.com/en-us/dotnet/fsharp/language-reference/sequences#sequence-expressions) expressions
311-
make initializing and transforming `'T list`, `'T array`, and `seq<'T>` quite nice:
311+
make initializing and transforming `'T list`, `'T array`, and `'T seq` quite nice:
312312

313313
#### List literal
314314

@@ -353,7 +353,7 @@ Or, to keep the ergonomics of sequence expressions, you must instantiate and ite
353353
let nums = ResizeArray [1; 2; 3]
354354
```
355355

356-
#### Instantiates and iterates over an intermediate `seq<int>`
356+
#### Instantiates and iterates over an intermediate `int seq`
357357

358358
```fsharp
359359
let nums = ResizeArray (seq { 1; 2; 3 })

docs/content/fsdocs-custom.css

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

docs/content/fsdocs-theme.css

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
:root {
2+
--monospace-font: 'Cascadia Code', 'Fira Code', monospace;
3+
}
4+
5+
pre,
6+
code,
7+
.fsdocs-tip,
8+
.fssnip {
9+
font-feature-settings: 'ss02', 'ss03', 'ss04', 'ss05', 'ss06', 'zero', 'onum', 'calt';
10+
}

0 commit comments

Comments
 (0)