Merge branch 'enhancement/5.x-generate-documentation' into 5.x

Author: russcam

build/scripts/Documentation.fsx

@@ -8,17 +8,30 @@ open System
 open Fake 
 
 open Paths
+open System.IO
 
 module Documentation = 
 
-    let RunLitterateur = fun _ ->
-        let litterateur = "src/CodeGeneration/Nest.Litterateur/bin/Release/Nest.Litterateur.exe"
+    let Generate() =
+        let generator = "build/output/v4.6/DocGenerator/DocGenerator.exe"
         ExecProcess (fun p ->
-            p.WorkingDirectory <- "src/CodeGeneration/Nest.Litterateur/bin/Release"
-            p.FileName <- litterateur
+            p.WorkingDirectory <- "src/CodeGeneration/DocGenerator"
+            p.FileName <- generator
           ) 
           (TimeSpan.FromMinutes (1.0)) |> ignore
 
+    // TODO: hook documentation validation into the process
+    let Validate() =
+        let elasticDocsDir = "../elasticsearch-docs"
+        if (directoryExists elasticDocsDir = false) then
+            let fullPath = combinePaths currentDirectory elasticDocsDir |> Path.GetFullPath
+            traceFAKE "No elasticsearch docs repo found at %s. Cannot validate generated documentation" fullPath
+        //else
+            // Needs to be able to run the build_docs.pl perl script. The best options on Windows for this
+            // are Cygwin or Linux Bash for Windows.
+            //let docBuildScript = combinePaths elasticDocsDir "build_docs.pl"
 
 
+        |> ignore
+
 

build/scripts/Paths.fsx

@@ -29,7 +29,7 @@ module Projects =
 
     type PrivateProject =
         | Tests
-    
+        | DocGenerator
 
 
     type DotNetProject = 
@@ -55,6 +55,7 @@ module Projects =
             | PrivateProject p ->
                 match p with
                 | Tests -> "Tests"
+                | DocGenerator -> "DocGenerator"
 
         static member TryFindName (name: string) =
             DotNetProject.All

build/scripts/Targets.fsx

@@ -19,6 +19,7 @@ open Versioning
 open Releasing
 open Profiling
 open XmlDocPatcher
+open Documentation
 
 // Default target
 Target "Build" <| fun _ -> traceHeader "STARTING BUILD"
@@ -32,13 +33,17 @@ Target "Test"  <| fun _ -> Tests.RunUnitTests()
 Target "InheritDoc"  <| fun _ -> InheritDoc.patchInheritDocs()
 
 Target "TestForever"  <| fun _ -> Tests.RunUnitTestsForever()
-
+    
 Target "Integrate"  <| fun _ -> Tests.RunIntegrationTests (getBuildParamOrDefault "esversions" "") (getBuildParamOrDefault "escluster" "") (getBuildParamOrDefault "testfilter" "")
 
 Target "Profile" <| fun _ -> Profiler.Run()
 
 Target "Benchmark" <| fun _ -> Benchmarker.Run()
 
+Target "Documentation" <| fun _ -> Documentation.Generate()
+
+Target "QuickCompile"  <| fun _ -> Build.QuickCompile()
+
 Target "Version" <| fun _ -> 
     Versioning.PatchAssemblyInfos()
     Versioning.PatchProjectJsons()
@@ -60,6 +65,7 @@ Target "Canary" <| fun _ ->
   ==> "BuildApp"
   =?> ("Test", (not ((getBuildParam "skiptests") = "1")))
   ==> "InheritDoc"
+  ==> "Documentation"
   ==> "Build"
 
 "Clean" 

src/CodeGeneration/DocGenerator/DocGenerator.csproj

@@ -20,7 +20,7 @@
     <DebugSymbols>true</DebugSymbols>
     <DebugType>full</DebugType>
     <Optimize>false</Optimize>
-    <OutputPath>..\Nest.Litterateur\bin\Net45\Debug\</OutputPath>
+    <OutputPath>bin\Debug\</OutputPath>
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
@@ -29,7 +29,7 @@
     <PlatformTarget>AnyCPU</PlatformTarget>
     <DebugType>pdbonly</DebugType>
     <Optimize>true</Optimize>
-    <OutputPath>..\Nest.Litterateur\bin\Net45\Release\</OutputPath>
+    <OutputPath>bin\Release\</OutputPath>
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>

src/CodeGeneration/DocGenerator/LitUp.cs

@@ -39,9 +39,15 @@ public static void Go(string[] args)
 				file.SaveToDocumentationFolder();
 			}
 
+			Console.ForegroundColor = ConsoleColor.Green;
+			Console.WriteLine("Documentation generated.");
+			Console.ResetColor();
+
 			if (Debugger.IsAttached)
+			{
 				Console.WriteLine("Press any key to continue...");
 				Console.ReadKey();
+			}
 		}
 	}
 }

src/CodeGeneration/DocGenerator/Program.cs

@@ -14,8 +14,8 @@ static Program()
 			}
 			else
 			{
-				InputDirPath = @"..\..\..\..\..\..\src\Tests";
-				OutputDirPath = @"..\..\..\..\..\..\docs";
+				InputDirPath = @"..\..\..\..\..\src\Tests";
+				OutputDirPath = @"..\..\..\..\..\docs";
 			}
 		}