private void GenerateTableOfContents(IList <GenerationManifest> manifests)
{
Info("Generating table of contents entries...");
var tocWriter = new TOCWriter(Options, manifests);
tocWriter.Write();
}
protected override void GenerateHelper()
{
base.GenerateHelper();
if (string.IsNullOrEmpty(SDKHelpRoot))
{
SDKHelpRoot = "http://docs.aws.amazon.com/sdkfornet/v3/apidocs/";
}
else if (!SDKHelpRoot.EndsWith("/"))
{
SDKHelpRoot = SDKHelpRoot + "/";
}
Console.WriteLine("Generating web help documentation:");
Console.WriteLine(".... SDK help base URI set to {0}", SDKHelpRoot);
Console.WriteLine(".... writing doc output to {0}", OutputFolder);
var buildLogsPath = Path.Combine(this.Options.RootPath, "logs");
if (!Directory.Exists(buildLogsPath))
{
Directory.CreateDirectory(buildLogsPath);
}
var logFile = Path.Combine(buildLogsPath, Name + ".dll-WebHelp.log");
var oldWriter = Console.Out;
try
{
using (var consoleWriter = new StreamWriter(File.OpenWrite(logFile)))
{
Console.SetOut(consoleWriter);
CleanWebHelpOutputFolder(OutputFolder);
CopyWebHelpStaticFiles(OutputFolder);
CreateVersionInfoFile(Path.Combine(OutputFolder, "items"));
var tocWriter = new TOCWriter(Options, OutputFolder);
tocWriter.AddFixedSection();
Parallel.ForEach(CmdletTypes, (cmdletType) =>
{
var(moduleName, serviceName) = DetermineCmdletServiceOwner(cmdletType);
var cmdletInfo = InspectCmdletAttributes(cmdletType);
string synopsis = null;
if (cmdletInfo.AWSCmdletAttribute == null)
{
Console.WriteLine("Unable to find AWSCmdletAttribute for type " + cmdletType.FullName);
}
else
{
var cmdletReturnAttributeType = cmdletInfo.AWSCmdletAttribute.GetType();
synopsis =
cmdletReturnAttributeType.GetProperty("Synopsis").GetValue(cmdletInfo.AWSCmdletAttribute, null) as
string;
}
foreach (var cmdletAttribute in cmdletInfo.CmdletAttributes)
{
var typeDocumentation = DocumentationUtils.GetTypeDocumentation(cmdletType,
AssemblyDocumentation);
typeDocumentation = DocumentationUtils.FormatXMLForPowershell(typeDocumentation, true);
Console.WriteLine($"Cmdlet = {cmdletType.FullName}");
Console.WriteLine($"Documentation = {typeDocumentation}");
var cmdletName = cmdletAttribute.VerbName + "-" + cmdletAttribute.NounName;
var allProperties = GetRootSimpleProperties(cmdletType);
var parameterPartitioning = new CmdletParameterSetPartitions(allProperties, cmdletAttribute.DefaultParameterSetName);
var serviceAbbreviation = GetServiceAbbreviation(cmdletType);
var cmdletPageWriter = new CmdletPageWriter(Options, OutputFolder, serviceName, moduleName, cmdletName);
WriteDetails(cmdletPageWriter, typeDocumentation, synopsis, cmdletInfo.AWSCmdletAttribute);
WriteSyntax(cmdletPageWriter, cmdletName, parameterPartitioning);
WriteParameters(cmdletPageWriter, cmdletName, allProperties, false);
WriteParameters(cmdletPageWriter, cmdletName, allProperties, true);
WriteOutputs(cmdletPageWriter, cmdletInfo.AWSCmdletOutputAttributes);
WriteNotes(cmdletPageWriter);
WriteExamples(cmdletPageWriter, cmdletName);
WriteRelatedLinks(cmdletPageWriter, serviceAbbreviation, cmdletName);
cmdletPageWriter.Write();
lock (tocWriter)
{
var legacyAlias = InspectForLegacyAliasAttribution(moduleName, cmdletName, cmdletInfo.AWSCmdletAttribute);
tocWriter.AddServiceCmdlet(moduleName, serviceName, cmdletName, cmdletPageWriter.GetTOCID(), synopsis, legacyAlias);
}
}
});
tocWriter.Write();
WriteLegacyAliasesPage();
}
}
finally
{
Console.SetOut(oldWriter);
}
}
/// <summary>
/// Runs the doc generator to produce or update a consistent documentation
/// set for the SDK.
/// </summary>
/// <param name="options"></param>
/// <returns>0 on successful completion</returns>
public int Execute(GeneratorOptions options)
{
// this is just to record the run duration, so we can monitor and optimize
// build-time perf
_startTimeTicks = DateTime.Now.Ticks;
Options = options;
Trace.Listeners.Add(new ConditionalConsoleTraceListener(Options.Verbose));
if (Options.TestMode)
{
SetOptionsForTestMode();
}
if (string.IsNullOrEmpty(Options.SDKAssembliesRoot))
{
Info("ERROR: SDKAssembliesRoot option not set");
return(-1);
}
if (Options.Verbose)
{
Info("Starting generation with options:");
Info("...TestMode: {0}", Options.TestMode);
Info("...Clean: {0}", Options.Clean);
Info("...WriteStaticContent: {0}", Options.WriteStaticContent);
Info("...WaitOnExit: {0}", Options.WaitOnExit);
Info("");
Info("...SDKAssembliesRoot: {0}", Options.SDKAssembliesRoot);
Info("...OutputFolder: {0}", Options.OutputFolder);
Info("...Platform: {0}", Options.Platform);
Info("...Services: {0}", string.Join(",", Options.Services));
Info("...CodeSamplesRootFolder: {0}", Options.CodeSamplesRootFolder);
Info("");
}
if (options.Clean)
{
FileUtilties.CleanFolder(options.OutputFolder, true);
}
if (!Directory.Exists(options.OutputFolder))
{
Directory.CreateDirectory(options.OutputFolder);
}
// use the sdk root and primary platform to determine the set of
// service manifests to process
var manifests = ConstructGenerationManifests();
TOCWriter = new TOCWriter(options);
GenerationManifest coreManifest = null;
DeferredTypesProvider deferredTypes = new DeferredTypesProvider(null);
foreach (var m in manifests)
{
if (m.ServiceName.Equals("Core", StringComparison.InvariantCultureIgnoreCase))
{
coreManifest = m;
continue;
}
m.Generate(deferredTypes, TOCWriter);
}
// now all service assemblies are processed, handle core plus any types in those assemblies that
// we elected to defer until we processed core.
coreManifest.ManifestAssemblyContext.SdkAssembly.DeferredTypesProvider = deferredTypes;
coreManifest.Generate(null, TOCWriter);
Info("Generating table of contents entries...");
TOCWriter.Write();
CopyVersionInfoManifest();
if (options.WriteStaticContent)
{
Info("Generating/copying static content:");
Info("...creating landing page");
var lpWriter = new LandingPageWriter(options);
lpWriter.Write();
Info("...copying static resources");
var sourceLocation = Directory.GetParent(typeof(SdkDocGenerator).Assembly.Location).FullName;
FileUtilties.FolderCopy(Path.Combine(sourceLocation, "output-files"), options.OutputFolder, true);
}
// Write out all the redirect rules for doc cross-linking.
using (Stream stream = File.Open(Path.Combine(options.OutputFolder, SDKDocRedirectWriter.RedirectFileName), FileMode.Create))
{
SDKDocRedirectWriter.Write(stream);
}
return(0);
}