diff --git a/.github/workflows/ghpages.yml b/.github/workflows/ghpages.yml index d54acc1..5895b45 100644 --- a/.github/workflows/ghpages.yml +++ b/.github/workflows/ghpages.yml @@ -11,11 +11,14 @@ jobs: - name: dotnet restore run: dotnet restore - - name: Install docfx - run: choco install docfx -y + - name: paket install + run: | + dotnet tool restore + dotnet paket install + working-directory: docs - name: Build - run: docfx + run: ./packages/docfx.console/tools/docfx working-directory: docs - name: Deploy diff --git a/.gitignore b/.gitignore index e120677..1ee5385 100644 --- a/.gitignore +++ b/.gitignore @@ -142,7 +142,9 @@ _TeamCity* !.axoCover/settings.json # Coverlet is a free, cross platform Code Coverage Tool -coverage*[.json, .xml, .info] +coverage*.json +coverage*.xml +coverage*.info # Visual Studio code coverage results *.coverage @@ -358,6 +360,3 @@ MigrationBackup/ # Fody - auto-generated XML schema FodyWeavers.xsd - -# docfx -_site/ diff --git a/docs/.config/dotnet-tools.json b/docs/.config/dotnet-tools.json new file mode 100644 index 0000000..c2706a7 --- /dev/null +++ b/docs/.config/dotnet-tools.json @@ -0,0 +1,12 @@ +{ + "version": 1, + "isRoot": true, + "tools": { + "paket": { + "version": "5.257.0", + "commands": [ + "paket" + ] + } + } +} \ No newline at end of file diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..e4e40b3 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,3 @@ +/_site/ +/paket.lock +/packages/ diff --git a/docs/docfx.json b/docs/docfx.json index c45a10e..88b12fa 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -24,7 +24,8 @@ ], "dest": "_site", "template": [ - "default" + "default", + "./packages/memberpage/content" ], "xrefService": [ "https://xref.docs.microsoft.com/query?uid={uid}" diff --git a/docs/paket.dependencies b/docs/paket.dependencies new file mode 100644 index 0000000..097dc18 --- /dev/null +++ b/docs/paket.dependencies @@ -0,0 +1,5 @@ +storage: packages +source https://api.nuget.org/v3/index.json + +nuget docfx.console ~> 2.56 +nuget memberpage ~> 2.56 diff --git a/src/BiDaFlow.AsyncEnumerable/Fluent/DataflowAsyncEnumerable.cs b/src/BiDaFlow.AsyncEnumerable/Fluent/DataflowAsyncEnumerable.cs index 5e42925..1b14a90 100644 --- a/src/BiDaFlow.AsyncEnumerable/Fluent/DataflowAsyncEnumerable.cs +++ b/src/BiDaFlow.AsyncEnumerable/Fluent/DataflowAsyncEnumerable.cs @@ -79,7 +79,7 @@ public static IAsyncEnumerable AsAsyncEnumerable(this ISourceB /// /// /// - /// diff --git a/src/BiDaFlow/Blocks/DropBlock.cs b/src/BiDaFlow/Blocks/DropBlock.cs index 5490f3e..059a52b 100644 --- a/src/BiDaFlow/Blocks/DropBlock.cs +++ b/src/BiDaFlow/Blocks/DropBlock.cs @@ -9,7 +9,7 @@ namespace BiDaFlow.Blocks /// Provides a dataflow block that drops input items. /// /// - /// (); /// for (int i = 1; i <= 5; i++) /// sourceBlock.Post(i); diff --git a/src/BiDaFlow/Fluent/FluentDataflow.cs b/src/BiDaFlow/Fluent/FluentDataflow.cs index a5c8899..fac3133 100644 --- a/src/BiDaFlow/Fluent/FluentDataflow.cs +++ b/src/BiDaFlow/Fluent/FluentDataflow.cs @@ -349,7 +349,7 @@ public static IPropagatorBlock Merge(this IPro /// /// /// This sample shows how to merge some source blocks. - /// > sources; /// ITargetBlock target; /// @@ -431,7 +431,7 @@ public static IDisposable LinkWithProbe(this ISourceBlock source, ITargetB /// , or is . /// - /// ("ExampleLink")); /// /// class ConsoleProbe : ILinkProbe