Skip to content

🪲 [Fix]: Moving docs one level out (not in a $ModuleName folder) #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Dec 7, 2024
Merged

🪲 [Fix]: Moving docs one level out (not in a $ModuleName folder) #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c75903a
Moving docs one level out (not in a modulename folder
MariusStorhaug Dec 7, 2024
7ab6f32
move to parrent
MariusStorhaug Dec 7, 2024
86e66da
🩹 [Patch]: Fix destination path for moving documentation files in Bui…
MariusStorhaug Dec 7, 2024
d21f0b2
test
MariusStorhaug Dec 7, 2024
d7c05ef
fix
MariusStorhaug Dec 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion scripts/helpers/Build-PSModule.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ function Build-PSModule {
$moduleOutputFolder = New-Item -Path $ModulesOutputFolderPath -Name $ModuleName -ItemType Directory -Force
Write-Verbose "Module output folder: [$moduleOutputFolder]"

$docsOutputFolder = New-Item -Path $DocsOutputFolderPath -Name $ModuleName -ItemType Directory -Force
$docsOutputFolder = New-Item -Path $DocsOutputFolderPath -ItemType Directory -Force
Write-Verbose "Docs output folder: [$docsOutputFolder]"
}

Expand Down
13 changes: 5 additions & 8 deletions scripts/helpers/Build/Build-PSModuleDocumentation.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,29 +71,26 @@ function Build-PSModuleDocumentation {
}
}

# Markdown files are called the same as the source files, but with a .md extension.
# They are all located flat in the docsoutputfolder.
# I want the markdown files to be moved in the same folder structure as the source files.
LogGroup 'Build docs - Structure markdown files to match source files' {
$PublicFunctions = Join-Path $ModuleSourceFolder.FullName 'functions\public' | Get-Item
$PublicFunctionsFolder = Join-Path $ModuleSourceFolder.FullName 'functions\public' | Get-Item
Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object {
$file = $_
Write-Verbose "Processing: $file"

# find the source code file that matches the markdown file
$scriptPath = Get-ChildItem -Path $PublicFunctions -Recurse -Force | Where-Object { $_.Name -eq ($file.BaseName + '.ps1') }
$scriptPath = Get-ChildItem -Path $PublicFunctionsFolder -Recurse -Force | Where-Object { $_.Name -eq ($file.BaseName + '.ps1') }
Write-Verbose "Found script path: $scriptPath"
$docsFilePath = ($scriptPath.FullName).Replace($PublicFunctions.FullName, $DocsOutputFolder.FullName).Replace('.ps1', '.md')
$docsFilePath = ($scriptPath.FullName).Replace($PublicFunctionsFolder.FullName, $DocsOutputFolder.FullName).Replace('.ps1', '.md')
Write-Verbose "Doc file path: $docsFilePath"
$docsFolderPath = Split-Path -Path $docsFilePath -Parent
New-Item -Path $docsFolderPath -ItemType Directory -Force
Move-Item -Path $file.FullName -Destination $docsFilePath -Force
}
# Get the MD files that are in the public functions folder and move them to the same place in the docs folder
Get-ChildItem -Path $PublicFunctions -Recurse -Force -Include '*.md' | ForEach-Object {
Get-ChildItem -Path $PublicFunctionsFolder -Recurse -Force -Include '*.md' | ForEach-Object {
$file = $_
Write-Verbose "Processing: $file"
$docsFilePath = ($file.FullName).Replace($PublicFunctions.FullName, $DocsOutputFolder.FullName)
$docsFilePath = ($file.FullName).Replace($PublicFunctionsFolder.FullName, $DocsOutputFolder.FullName)
Write-Verbose "Doc file path: $docsFilePath"
$docsFolderPath = Split-Path -Path $docsFilePath -Parent
New-Item -Path $docsFolderPath -ItemType Directory -Force
Expand Down