docs

krauthaufen · krauthaufen · commit caf736ac4cf0 · 2022-03-21T09:01:01.000+01:00
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -19,6 +19,12 @@
         "commands": [
           "aardpack"
         ]
+    },
+    "fsdocs-tool": {
+        "version": "15.0.0",
+        "commands": [
+            "fsdocs"
+        ]
     }
   }
 }
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,25 @@
+name: Docs
+on:
+  push:
+    branches:
+      - master
+      - updates
+    paths:
+      - RELEASE_NOTES.md
+      - .github/workflows/docs.yml  
+  docs:
+    name: Docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install Dotnet
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '6.0.100'
+      - name: Restore Tools
+        run: dotnet tool restore
+      - name: Paket Restore
+        run: dotnet paket restore
+      - name: Build
+        run: ./docs.sh
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -70,8 +70,8 @@ jobs:
         with:
           name: packages
           path: bin\pack
-      # - name: NuGet
-      #   env:
-      #     NUGET_KEY: ${{ secrets.NUGET_KEY }}
-      #   shell: cmd
-      #   run: dotnet nuget push "bin\pack\*.nupkg" -k %NUGET_KEY% -s "https://api.nuget.org/v3/index.json" --skip-duplicate
+      - name: NuGet
+        env:
+          NUGET_KEY: ${{ secrets.NUGET_KEY }}
+        shell: cmd
+        run: dotnet nuget push "bin\pack\*.nupkg" -k %NUGET_KEY% -s "https://api.nuget.org/v3/index.json" --skip-duplicate
diff --git a/.gitignore b/.gitignore
@@ -26,4 +26,7 @@ symbolCache.db
 /src/Demo/Fable/fable/
 **/node_modules/
 /bin/pack
-**/.DS_Store
+**/.DS_Store
+/tmp/
+/.fsdocs
+/output
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -16,5 +16,7 @@
         "paket-files/": true,
         "packages/": true,
         "**/BenchmarkDotNet.Artifacts/": true,
+        ".fsdocs": true,
+        "tmp": true
     }
 }
diff --git a/docs.sh b/docs.sh
@@ -0,0 +1,12 @@
+#! /bin/sh
+dotnet fsdocs build
+URL=$(git remote get-url origin)
+git clone --depth 1 -b gh-pages $URL ./doctmp
+rm -dfr doctmp/**
+cp -R output/** doctmp
+cd doctmp
+git add .
+git commit -m "Update docs"
+git push origin gh-pages
+cd ..
+rm -dfr doctmp
diff --git a/docs/img/logo.png b/docs/img/logo.png
diff --git a/docs/index.fsx b/docs/index.fsx
@@ -1,5 +1,5 @@
 (*** hide ***)
-#I "../../bin/Release/netstandard2.0"
+#I "../bin/Debug/netstandard2.0"
 #r "netstandard"
 #r "FSharp.Data.Adaptive.dll"
 open FSharp.Data.Adaptive
diff --git a/docs/tools/generate.fsx b/docs/tools/generate.fsx
diff --git a/docs/tools/packages.config b/docs/tools/packages.config
diff --git a/docs/tools/templates/template.cshtml b/docs/tools/templates/template.cshtml
diff --git a/src/FSharp.Data.Adaptive/FSharp.Data.Adaptive.fsproj b/src/FSharp.Data.Adaptive/FSharp.Data.Adaptive.fsproj
@@ -4,6 +4,16 @@
     <OutputType>Library</OutputType>
     <TargetFrameworks>netstandard2.0;netcoreapp3.1</TargetFrameworks>
     <DisableImplicitFSharpCoreReference>true</DisableImplicitFSharpCoreReference>
+
+    <!-- Example ultra-simple styling and generation settings for FsDocs default template-->
+    <PackageLicenseUrl>https://github.com/fsprojects/FSharp.Data.Adaptive/blob/master/LICENSE</PackageLicenseUrl>
+    <PackageProjectUrl>https://fsprojects.github.io/FSharp.Data.Adaptive</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/fsprojects/FSharp.Data.Adaptive/tree/master</RepositoryUrl>
+    <FsDocsLogoLink>./index.html</FsDocsLogoLink>
+    <FsDocsLicenseLink>https://github.com/fsprojects/FSharp.Data.Adaptive/blob/master/LICENSE</FsDocsLicenseLink>
+    <FsDocsReleaseNotesLink>https://github.com/fsprojects/FSharp.Data.Adaptive/blob/master/RELEASE_NOTES.md</FsDocsReleaseNotesLink>
+    <FsDocsNavbarPosition>fixed-left</FsDocsNavbarPosition>
+    <FsDocsTheme>default</FsDocsTheme>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
     <OutputPath>..\..\bin\Debug\</OutputPath>

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,12 @@`
`19`	`19`	`"commands": [`
`20`	`20`	`"aardpack"`
`21`	`21`	`]`
	`22`	`+ },`
	`23`	`+ "fsdocs-tool": {`
	`24`	`+ "version": "15.0.0",`
	`25`	`+ "commands": [`
	`26`	`+ "fsdocs"`
	`27`	`+ ]`
`22`	`28`	`}`
`23`	`29`	`}`
`24`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,5 +16,7 @@`
`16`	`16`	`"paket-files/": true,`
`17`	`17`	`"packages/": true,`
`18`	`18`	`"**/BenchmarkDotNet.Artifacts/": true,`
	`19`	`+ ".fsdocs": true,`
	`20`	`+ "tmp": true`
`19`	`21`	`}`
`20`	`22`	`}`