2018-12-28 09:09:35 +00:00
|
|
|
|
<#
|
2018-10-14 12:10:18 +00:00
|
|
|
|
.SYNOPSIS
|
|
|
|
|
|
Refreshes MD documentation files and builds MAML files.
|
|
|
|
|
|
|
|
|
|
|
|
.AUTHOR
|
|
|
|
|
|
Przemysław Kłys (@PrzemyslawKlys)
|
|
|
|
|
|
#>
|
2018-12-28 09:09:35 +00:00
|
|
|
|
#Requires -Version 5 -Module platyPS
|
2018-10-14 12:10:18 +00:00
|
|
|
|
|
|
|
|
|
|
# Set directory paths
|
|
|
|
|
|
$rootDir = Split-Path $PSScriptRoot -Parent
|
|
|
|
|
|
$locale = 'en-US'
|
|
|
|
|
|
$dsInternalsModulePath = Join-Path $rootDir 'Build\bin\Release\DSInternals'
|
|
|
|
|
|
$mdHelpPath = Join-Path $rootDir 'Documentation\PowerShell'
|
2019-01-12 18:58:56 +00:00
|
|
|
|
$modulePagePath = Join-Path $mdHelpPath 'Readme.md'
|
2018-10-14 12:10:18 +00:00
|
|
|
|
$xmlHelpPath = Join-Path $rootDir "Src\DSInternals.PowerShell\$locale"
|
|
|
|
|
|
|
|
|
|
|
|
# Import dependencies
|
|
|
|
|
|
Import-Module -Name platyPS
|
2018-12-28 09:09:35 +00:00
|
|
|
|
Import-Module -Name $dsInternalsModulePath
|
2018-10-14 12:10:18 +00:00
|
|
|
|
|
|
|
|
|
|
<#
|
|
|
|
|
|
Note: This code has been used to create the initial version of the help files:
|
|
|
|
|
|
New-MarkdownHelp -Module DSInternals -AlphabeticParamsOrder -Locale $locale -WithModulePage -HelpVersion 1.0 -OutputFolder $mdHelpPath
|
|
|
|
|
|
New-MarkdownAboutHelp -AboutName DSInternals -OutputFolder $mdHelpPath
|
|
|
|
|
|
#>
|
|
|
|
|
|
|
|
|
|
|
|
# Update MD files
|
2019-01-12 18:58:56 +00:00
|
|
|
|
Update-MarkdownHelpModule -Path $mdHelpPath -ModulePagePath $modulePagePath -RefreshModulePage -AlphabeticParamsOrder -UpdateInputOutput
|
2018-10-14 12:10:18 +00:00
|
|
|
|
|
|
|
|
|
|
# Generate the MAML file
|
2019-01-12 18:58:56 +00:00
|
|
|
|
New-ExternalHelp -Path $mdHelpPath -OutputPath $xmlHelpPath -Force -ShowProgress
|
