-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Experimental: wrapper code to generate PS and ARM template docs
- Loading branch information
1 parent
307a90d
commit 9c1d437
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
<# | ||
.SYNOPSIS | ||
Generates documentation for select PowerShell modules and ARM templates in this repo. | ||
#> | ||
|
||
#Requires -Modules platyPS, Az.Resources, PSDocs.Azure | ||
|
||
# Generate markdown help for the AzSubscriptionManagement module using platyPS | ||
try { | ||
Import-Module platyPS | ||
Import-Module ../Modules/AzSubscriptionManagement.psm1 -ErrorAction Continue | ||
|
||
New-MarkDownHelp -Module AzSubscriptionManagement -OutputFolder ../Modules/docs -Force | ||
} | ||
finally { | ||
Remove-Module AzSubscriptionManagement | ||
Remove-Module platyPS | ||
} | ||
|
||
# Generate markdown help for the research hub module using PSDocs | ||
try { | ||
bicep build ../../../research-spoke/main.bicep | ||
Invoke-PSDocument -Path ../../../research-spoke/ -OutputPath ./docs | ||
} | ||
finally { | ||
Remove-Item -Path ../../../research-spoke/main.json -Force | ||
Remove-Module PSDocs.Azure | ||
} | ||
|
||
# TODO: Generate docs for research hub template |