Some changes to help build release docs (#387)

* Add basic namespace docs * Rename license to be .md so default links work * Remove deleted template ref * Docs now link directly to github so don't copy into docsrc
fsprojects · Oct 26, 2020 · 2f4df5f · 2f4df5f
1 parent 8be8d8d
commit 2f4df5f
Show file tree

Hide file tree

Showing 10 changed files with 34 additions and 17 deletions.
diff --git a/.gitignore b/.gitignore
@@ -197,8 +197,6 @@ release.cmd
 release.sh
 localpackages/
 *.orig
-docsrc/content/license.md
-docsrc/content/release-notes.md
 .fake
 docsrc/tools/FSharp.Formatting.svclog
 

diff --git a/FSharpPlus.sln b/FSharpPlus.sln
@@ -13,9 +13,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "project", "project", "{BF60
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tools", "tools", "{83F16175-43B1-4C90-A1EE-8E351C33435D}"
-	ProjectSection(SolutionItems) = preProject
-		docsrc\tools\templates\template.cshtml = docsrc\tools\templates\template.cshtml
-	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "content", "content", "{8E6D5255-776D-4B61-85F9-73C37AA1FB9A}"
 	ProjectSection(SolutionItems) = preProject

diff --git a/LICENSE.txt → LICENSE.md b/LICENSE.txt → LICENSE.md
diff --git a/docsrc/tools/Program.fs b/docsrc/tools/Program.fs
@@ -66,16 +66,6 @@ Target.create "Build" (fun _ ->
            )
 )
 
-Target.create "Docs" (fun _ ->
-    System.IO.File.Delete ( rootDir @@ "docsrc/content/release-notes.md" )
-    Shell.copyFile (rootDir @@ "docsrc/content/") "RELEASE_NOTES.md"
-    Shell.rename ( rootDir @@ "docsrc/content/release-notes.md" ) "docsrc/content/RELEASE_NOTES.md"
-
-    System.IO.File.Delete ( rootDir @@ "docsrc/content/license.md" )
-    Shell.copyFile ( rootDir @@ "docsrc/content/" ) "LICENSE.txt"
-    Shell.rename ( rootDir @@ "docsrc/content/license.md" ) "docsrc/content/LICENSE.txt"
-)
-
 // --------------------------------------------------------------------------------------
 // Post process here:
 

diff --git a/src/FSharpPlus/Builders.fs b/src/FSharpPlus/Builders.fs
@@ -1,5 +1,14 @@
 namespace FSharpPlus
 
+/// <namespacedoc>
+/// <summary>
+/// Extension modules, along with, Builders, Lens, Memoization, Operators, and Parsing.
+/// </summary>
+/// <remarks>
+/// See Operators for generic functions.
+/// </remarks>
+/// </namespacedoc>
+
 #nowarn "40"
 
 #if !FABLE_COMPILER

diff --git a/src/FSharpPlus/Control/Alternative.fs b/src/FSharpPlus/Control/Alternative.fs
@@ -1,4 +1,10 @@
-namespace FSharpPlus.Control
+namespace FSharpPlus.Control 
+
+/// <namespacedoc>
+/// <summary>
+/// Generally internal and not useful directly - contains generic function overloaded implementations.
+/// </summary>
+/// </namespacedoc>
 
 #if !FABLE_COMPILER
 

diff --git a/src/FSharpPlus/Data/Cont.fs b/src/FSharpPlus/Data/Cont.fs
@@ -1,5 +1,11 @@
 namespace FSharpPlus.Data
 
+/// <namespacedoc>
+/// <summary>
+/// Data contains types and modules that represent data structures designed to be used with F#+ abstractions.
+/// </summary>
+/// </namespacedoc>
+
 #nowarn "1125"
 
 open System.ComponentModel

diff --git a/src/FSharpPlus/Internals.fs b/src/FSharpPlus/Internals.fs
@@ -1,5 +1,11 @@
 namespace FSharpPlus.Internals
 
+/// <namespacedoc>
+/// <summary>
+/// Internal to the library - please ignore
+/// </summary>
+/// </namespacedoc>
+ 
 type Default6 = class end
 type Default5 = class inherit Default6 end
 type Default4 = class inherit Default5 end

diff --git a/src/FSharpPlus/Math/Applicative.fs b/src/FSharpPlus/Math/Applicative.fs
@@ -1,5 +1,11 @@
 namespace FSharpPlus.Math
 
+/// <namespacedoc>
+/// <summary>
+/// Math operators and generic functions
+/// </summary>
+/// </namespacedoc>
+ 
 #if !FABLE_COMPILER
 
 open FSharpPlus

diff --git a/src/FSharpPlus/Operators.fs b/src/FSharpPlus/Operators.fs
@@ -6,7 +6,6 @@ open FSharpPlus.Control
 [<AutoOpenAttribute>]
 module Operators =
 
-
     // Common combinators
 
     /// <summary>Creates a new function with first two arguments flipped.</summary>