generated from dopt-python/py311
add documentation including build process
This commit is contained in:
@@ -8,6 +8,7 @@ $ENV_PATH = 'B:\deployments\WCE-NAFKA\dopt_nafka_wce-crm'
|
||||
$PY_PATH = Join-Path -Path $ENV_PATH -ChildPath 'python'
|
||||
$SRC_PATH = (Get-Location).Path
|
||||
|
||||
|
||||
Write-Output "Build Pipeline for d-opt WCE/NAFKA project"
|
||||
|
||||
Write-Output "Delete existing artifacts..."
|
||||
@@ -108,6 +109,26 @@ if ($? -eq $false){
|
||||
}
|
||||
Write-Output "Copied startup scripts successfully"
|
||||
|
||||
# documentation
|
||||
Write-Output "Generate manual..."
|
||||
Set-Location $SRC_PATH
|
||||
# $doc_build_script = Join-Path -Path $SRC_PATH -ChildPath "scripts\cvt_docs.ps1" -Resolve
|
||||
.\scripts\cvt_docs.ps1
|
||||
if ($? -eq $false){
|
||||
Write-Output "[PWSH] Exiting script because there errors while generating the doc files"
|
||||
Exit
|
||||
}
|
||||
Write-Output "Generated doc files successfully"
|
||||
Write-Output "Copying manual file..."
|
||||
$docs_src_path = Join-Path -Path $SRC_PATH -ChildPath 'docs\*.pdf'
|
||||
# $docs_dest_path = Join-Path -Path $ENV_PATH -ChildPath 'manual'
|
||||
Copy-Item -Path $docs_src_path -Destination $ENV_PATH -Force
|
||||
if ($? -eq $false){
|
||||
Write-Output "[PWSH] Exiting script because there were errors while copying the doc files"
|
||||
Exit
|
||||
}
|
||||
Write-Output "Copied doc files successfully"
|
||||
Set-Location $ENV_PATH
|
||||
|
||||
# env preparation
|
||||
Write-Output "Preparing environment with cleanup and pre-compilation..."
|
||||
|
||||
3
scripts/cvt_docs.ps1
Normal file
3
scripts/cvt_docs.ps1
Normal file
@@ -0,0 +1,3 @@
|
||||
# convert README Markdown file to PDF as a manual
|
||||
pandoc .\README.md -o .\docs\Kurzanleitung.pdf -V geometry:"a4paper, margin=2.5cm" -V header-includes="\usepackage[none]{hyphenat}"
|
||||
pandoc .\docs\Versionshistorie.md -o .\docs\Versionshistorie.pdf -V geometry:"a4paper, margin=2.5cm" -V header-includes="\usepackage[none]{hyphenat}"
|
||||
Reference in New Issue
Block a user