Skip to content

Commit af014c4

Browse files
dsymedsyme
committed
move to fsdocs
1 parent 077ba96 commit af014c4

26 files changed

Lines changed: 1012 additions & 319 deletions

‎.config/dotnet-tools.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
"version": 1,
33
"isRoot": true,
44
"tools": {
5+
"fsharp.formatting.commandtool": {
6+
"version": "6.0.7",
7+
"commands": [
8+
"fsdocs"
9+
]
10+
},
511
"paket": {
612
"version": "5.247.4",
713
"commands": [

‎Directory.Build.props‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<Project>
2+
<Import Project="version.props" />
3+
4+
</Project>

‎build.fsx‎

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,6 @@ Target.create "Clean" (fun _ ->
6060
Shell.cleanDirs ["bin"; "temp"]
6161
)
6262

63-
// Helper active pattern for project types
64-
let (|Fsproj|Csproj|Vbproj|Shproj|) (projFileName:string) =
65-
match projFileName with
66-
| f when f.EndsWith("fsproj") -> Fsproj
67-
| f when f.EndsWith("csproj") -> Csproj
68-
| f when f.EndsWith("vbproj") -> Vbproj
69-
| f when f.EndsWith("shproj") -> Shproj
70-
| _ -> failwith (sprintf "Project file %s not supported. Unknown project type." projFileName)
71-
7263
// Generate assembly info files with the right version & up-to-date information
7364
Target.create "AssemblyInfo" (fun _ ->
7465
let info = [
@@ -86,9 +77,6 @@ Target.create "AssemblyInfo" (fun _ ->
8677
File.WriteAllText("version.props", sprintf """<Project>
8778
<PropertyGroup>
8879
<Version>%s</Version>
89-
<PackageReleaseNotes>
90-
%s
91-
</PackageReleaseNotes>
9280
</PropertyGroup>
9381
</Project>""" release.NugetVersion releaseNotes)
9482
)
@@ -130,9 +118,8 @@ Target.create "NuGet" (fun _ ->
130118
// Generate the documentation
131119

132120
Target.create "GenerateDocs" (fun _ ->
133-
()
134-
// Shell.cleanDir ".fsdocs"
135-
// DotNet.exec id "fsdocs" "build --clean" |> ignore
121+
Shell.cleanDir ".fsdocs"
122+
DotNet.exec id "fsdocs" "build --clean" |> ignore
136123
)
137124

138125
// --------------------------------------------------------------------------------------

docs/content/library/AsyncSeq.fsx renamed to docs/AsyncSeq.fsx

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,25 @@
1+
(*** condition: prepare ***)
2+
#nowarn "211"
3+
#I "../src/FSharp.Control.AsyncSeq/bin/Release/netstandard2.1"
4+
#r "FSharp.Control.AsyncSeq.dll"
5+
(*** condition: fsx ***)
6+
#if FSX
7+
#r "nuget: FSharp.Control.AsyncSeq,{{package-version}}"
8+
#endif // FSX
9+
(*** condition: ipynb ***)
10+
#if IPYNB
11+
#r "nuget: FSharp.Control.AsyncSeq,{{package-version}}"
12+
#endif // IPYNB
13+
14+
115
(**
16+
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fsprojects/FSharp.Control.AsyncSeq/gh-pages?filepath=AsyncSeq.ipynb)
217
318
# F# Async: FSharp.Control.AsyncSeq
419
520
An AsyncSeq is a sequence in which individual elements are retrieved using an `Async` computation.
6-
It is similar to `seq<'a>` in that subsequent elements are pulled on-demand. Structurally it is
7-
similar to `list<'a>` with the difference being that each head and tail node or empty node is wrapped
8-
in `Async`. `AsyncSeq` also bears similarity to `IObservable<'a>` with the former being based on an "asynchronous pull" and the
21+
It is similar to `seq<'a>` in that subsequent elements are pulled on-demand.
22+
`AsyncSeq` also bears similarity to `IObservable<'a>` with the former being based on an "asynchronous pull" and the
923
latter based on a "synchronous push". Analogs for most operations defined for `Seq`, `List` and `IObservable` are also defined for
1024
`AsyncSeq`. The power of `AsyncSeq` lies in that many of these operations also have analogs based on `Async`
1125
allowing composition of complex asynchronous workflows.

docs/content/library/AsyncSeqExamples.fsx renamed to docs/AsyncSeqExamples.fsx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
1+
(*** condition: prepare ***)
2+
#nowarn "211"
3+
#I "../src/FSharp.Control.AsyncSeq/bin/Release/netstandard2.1"
4+
#r "FSharp.Control.AsyncSeq.dll"
5+
(*** condition: fsx ***)
6+
#if FSX
7+
#r "nuget: FSharp.Control.AsyncSeq,{{package-version}}"
8+
#endif // FSX
9+
(*** condition: ipynb ***)
10+
#if IPYNB
11+
#r "nuget: FSharp.Control.AsyncSeq,{{package-version}}"
12+
#endif // IPYNB
13+
14+
115
(**
16+
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/fsprojects/FSharp.Control.AsyncSeq/gh-pages?filepath=AsyncSeqExamples.ipynb)
217
318
# F# AsyncSeq Examples
419

‎docs/FsharpAsyncSeq.eps‎

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

‎docs/FsharpAsyncSeq.svg‎

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

‎docs/_template.html‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<!--
6+
The {page-title} parameters will be replaced with the
7+
document title extracted from the <h1> element or
8+
file name, if there is no <h1> heading
9+
-->
10+
<title>{{page-title}}</title>
11+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
12+
13+
<meta name="author" content="{{authors}}">
14+
15+
<script src="https://code.jquery.com/jquery-1.8.0.js"></script>
16+
<script src="https://code.jquery.com/ui/1.8.23/jquery-ui.js"></script>
17+
<script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/js/bootstrap.min.js"></script>
18+
<script type="text/javascript" async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
19+
<link href="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/css/bootstrap-combined.min.css" rel="stylesheet">
20+
21+
<link type="text/css" rel="stylesheet" href="{{root}}/content/style.css" />
22+
<script src="{{root}}/content/tips.js" type="text/javascript"></script>
23+
24+
<!-- BEGIN SEARCH BOX: this adds support for the search box -->
25+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.css" />
26+
<!-- END SEARCH BOX: this adds support for the search box -->
27+
</head>
28+
<body>
29+
<div class="container">
30+
<div class="masthead">
31+
<ul class="nav nav-pills pull-right">
32+
<li><a href="https://fsharp.org">fsharp.org</a></li>
33+
</ul>
34+
<h3 class="muted">{{project-name}}</h3>
35+
</div>
36+
<hr />
37+
<div class="row">
38+
<div class="span9" id="main">
39+
{{document}}
40+
{{tooltips}}
41+
</div>
42+
<div class="span3">
43+
<a href="index.html"><img src="{{root}}/img/logo.png" style="width:140px;height:140px;margin:10px 0px 0px 20px;border-style:none;"/></a>
44+
45+
<!-- BEGIN SEARCH BOX: this adds support for the search box -->
46+
<div id="header">
47+
<div class="searchbox">
48+
<label for="search-by">
49+
<i class="fas fa-search"></i>
50+
</label>
51+
<input data-search-input="" id="search-by" type="search" placeholder="Search..." />
52+
<span data-search-clear="">
53+
<i class="fas fa-times"></i>
54+
</span>
55+
</div>
56+
</div>
57+
<!-- END SEARCH BOX: this adds support for the search box -->
58+
59+
<ul class="nav nav-list" id="menu">
60+
<li class="nav-header">{{project-name}}</li>
61+
<li class="divider"></li>
62+
<li><a href="{{root}}/index.html">Home Page</a></li>
63+
<li><a href="https://github.com/fsprojects/FSharp.Control.AsyncSeq/">GitHub Page</a></li>
64+
65+
<li class="nav-header">Getting Started</li>
66+
<li class="divider"></li>
67+
<li><a href="{{root}}/terminology.html">Terminology</a></li>
68+
<li><a href="{{root}}/AsyncSeq.html">AsyncSeq</a></li>
69+
<li><a href="{{root}}/AsyncSeqExamples.html">AsyncSeq Examples</a></li>
70+
<li><a href="{{root}}/reference/index.html">API Reference</a></li>
71+
</ul>
72+
</div>
73+
</div>
74+
</div>
75+
<!-- BEGIN SEARCH BOX: this adds support for the search box -->
76+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.css" />
77+
<script type="text/javascript">var baseurl = '{{root}}'</script>
78+
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/lunr.js/2.3.8/lunr.min.js"></script>
79+
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/JavaScript-autoComplete/1.0.4/auto-complete.min.js"></script>
80+
<script type="text/javascript" src="{{root}}/content/search.js"></script>
81+
<!-- END SEARCH BOX: this adds support for the search box -->
82+
</body>
83+
</html>
84+
85+

‎docs/content/img/github-blue.png‎

817 Bytes
Loading

‎docs/content/img/github.png‎

806 Bytes
Loading

0 commit comments

Comments
 (0)