updated to error out on VS preview builds for docfx so the reason for the failure is a bit more obvious than the generic failure from docfx

Author: smaillet

Directory.Build.props

@@ -64,7 +64,7 @@
                 <OutputPath Condition="!HasTrailingSlash('$(OutputPath)')">$(OutputPath)\</OutputPath>
             </PropertyGroup>
             <ItemGroup Condition="'$(NoCommonAnalyzers)'!='true' and '$(IsTestProject)' != 'true' and '$(SourceLinkEnabled)' != 'false'">
-                 <PackageReference Include="SourceLink.Create.CommandLine" Version="2.7.4" PrivateAssets="All" />
+                 <PackageReference Include="SourceLink.Create.CommandLine" Version="2.8.0" PrivateAssets="All" />
             </ItemGroup>
             <ItemGroup Condition="'$(NoCommonAnalyzers)'!='true'">
                 <PackageReference Include="Microsoft.AnalyzerPowerPack" Version="1.1.0" PrivateAssets="All" />

SampleArgs/Program.cs

@@ -6,6 +6,10 @@
 using System.ComponentModel;
 using Ubiquity.CommandlineParsing;
 
+// warning SA1652: Enable XML documentation output
+// This is a sample app and not a documented API
+#pragma warning disable SA1652
+
 namespace SampleArgs
 {
     public static class Program

Ubiquity.CommandlineParsing.docfx/Ubiquity.CommandlineParsing.docfx.csproj

@@ -1,5 +1,4 @@
 <Project Sdk="Microsoft.NET.Sdk">
-    
     <PropertyGroup>
         <TargetFramework>net47</TargetFramework>
     </PropertyGroup>
@@ -11,15 +10,14 @@
 
     <ItemGroup>
         <PackageReference Include="CSemVer.Build.Tasks" Version="1.0.3-beta--ci-BLD.431367438" />
-        <PackageReference Include="docfx.console" Version="2.29.1" Condition="'$(TargetFramework)'=='net47'" PrivateAssets="All" />
-        <PackageReference Include="memberpage" Version="2.29.1" Condition="'$(TargetFramework)'=='net47'" PrivateAssets="All" />
+        <PackageReference Include="docfx.console" Version="2.31.0" Condition="'$(TargetFramework)'=='net47'" PrivateAssets="All" />
+        <PackageReference Include="memberpage" Version="2.31.0" Condition="'$(TargetFramework)'=='net47'" PrivateAssets="All" />
         <PackageReference Include="msdn.4.5.2" Version="0.1.0-alpha-1611021200" Condition="'$(TargetFramework)'=='net47'" PrivateAssets="All" />
     </ItemGroup>
 
-    
     <!--
     This target dynamically resolves the installed location of the NuGet Packages used and applies
-    appropriate parameters to the docfx command to use them. Otherwise the docfx.json would need to
+    appropriate parameters to the DocFx command to use them. Otherwise the docfx.json would need to
     have a hard coded path, which doesn't work with multiple users of a version controlled project.
     It also removes the need to workaround the hard coded path with relative paths by using a
     nuget.config to force package installs to a well known location.
@@ -35,14 +33,16 @@
             <MemberPagePath>%(memberpage.ResolvedPath)</MemberPagePath>
             <MsdnXRefPath>%(msdn4_5_2.ResolvedPath)</MsdnXRefPath>
             <LogLevel>Info</LogLevel>
-            <LogFile>$(IntermediateOutputPath)Docfx-Metadata.log</LogFile>
+            <LogFile>$(IntermediateOutputPath)DocFx-Metadata.log</LogFile>
             <DocParameters>$(DocParameters) --cleanupCacheHistory</DocParameters>
             <DocParameters>$(DocParameters) --lruSize=0</DocParameters>
             <DocParameters>$(DocParameters) --globalMetadata="{_buildVersion:\"$(FullBuildNumber)\"}"</DocParameters>
             <DocParameters>$(DocParameters) --intermediateFolder="$(IntermediateOutputPath.TrimEnd('\'))"</DocParameters>
             <DocParameters>$(DocParameters) --xref="$(MsdnXrefPath)\content\msdn.4.5.2.zip,$(MsdnXrefPath)\content\namespaces.4.5.2.zip"</DocParameters>
             <DocTemplate>statictoc,$(MemberPagePath)\content,templates\Ubiquity</DocTemplate>
         </PropertyGroup>
+        <!-- NOTE: MSBuildVersion property is new in 15.6 (as of 15.6.0-pre.4.0 the value is 15.6.76 )  -->
+        <Error Code="DOCFX:0001" ContinueOnError="false" Condition="$(MSBuildVersion)!=''" Text="As of DOCFX 2.31 docfx cannot generate metadata for CSPROJ files using VS 15.6.*" />
     </Target>
 
     <!-- Stub the build target as this project only builds the documentation -->

Ubiquity.CommandlineParsing.docfx/docfx.json

@@ -27,7 +27,7 @@
                    "api/**.md",
                    "api/**.yml",
                    "articles/**.md",
-                   "articles/**.yml",
+                   "articles/**.yml"
                  ],
          "src" : "."
       }
@@ -48,7 +48,7 @@
     {
       "_appTitle" : "Command line parsing",
       "_appFooter" : "Copyright (C) 2017, Ubiquity.NET contributors",
-      "_disableBreadcrumb" : true,
-    },
+      "_disableBreadcrumb" : true
+    }
   }
 }

Ubiquity.CommandlineParsing.docfx/templates/Ubiquity/readme.md

@@ -15,5 +15,5 @@ Changes:
 * Added Collapse region for Inheritance chain (Initially collapsed)
 * Added Collapse region for Derived classes list (Initially collapsed)
 * Added Collapse region for Implemented interfaces (Initially collapsed)
-* Added llvm language from highlightjs.org as it is not part of the docfx.vendor.js by default
+* Added llvm language and EBNF from highlightjs.org as those languages are not part of the docfx.vendor.js by default
 

Ubiquity.CommandlineParsing.docfx/templates/Ubiquity/styles/main.css

@@ -277,14 +277,18 @@ article {
     overflow: visible;
 }
 
+.toc .level1 > li {
+    font-weight: bold;
+    font-size: 14px;
+}
+
 toc .level2 {
     font-weight: normal;
-    font-size: inherit;
+    font-size: 12px;
 }
 
-.toc .level1 > li {
-    font-weight: bold;
-    font-size: inherit;
+.sidetoggle div {
+  Width: 300px;
 }
 
 /* Overrides for - Ubiquity DocFX Dark theme */

readme.md

@@ -11,8 +11,9 @@ target run-times
 
 While the code is functional and even has some tests it isn't maintained or released as
 an actual supported project. New ideas in the way things are built including docs and versioning etc... will
-appear here first before actual projects. To accomplish the goals some reasonable real code was needed so this
-old library originally written to explore the Sprache parse was given a new lease on life as a "test dummy" of sorts.
+appear here first before actual projects. To accomplish the goals some reasonable real code was needed. So this
+old library, originally written to explore the Sprache parser, was given a new lease on life as a "test dummy"
+of sorts.
 
 # OK, But I'm looking for a commandline parser...
 May we suggest [this one]( https://github.com/commandlineparser/commandline ) - it's on GitHub and MUCH more full