1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
# .SYNOPSIS
# Please use '.\make.ps1 -<target>' where <target> is one of:
# html, dirhtml, singlehtml, pickle, json, linkcheck
#
# .DESCRIPTION
# This is a front-end script for Sphinx.
#
# .EXAMPLE
# .\make.ps1 -clean
# Cleanup the build directory.
# .EXAMPLE
# .\make.ps1 -html
# Build documentation as HTML pages.
# .EXAMPLE
# .\make.ps1 -clean -html -linkcheck
# Combine multiple commands in a single call
#
#
# ==========================================================================
# Copyright © 2016-2017 Patrick Lehmann - Dresden, Germany
# ==========================================================================
[CmdletBinding()]
param(
# Make all targets
[switch]$all = $false,
# Extract VHDL documentation
[switch]$html = $false,
# Make HTML files named index.html in directories
[switch]$dirhtml = $false,
# Make a single large HTML file
[switch]$singlehtml = $false,
# Make a PDF file
[switch]$latex = $false,
[switch]$pdf = $false,
# Make pickle files
[switch]$pickle = $false,
# Make json files
[switch]$json = $false,
# Check all external links for integrity
[switch]$linkcheck = $false,
# Clean up directory before running Sphinx.
[switch]$clean = $false,
# Show the embedded help page(s).
[switch]$help = $false
)
# resolve paths
$WorkingDir = Get-Location
$SphinxRootDir = Convert-Path (Resolve-Path ($PSScriptRoot))
# set default values
$EnableVerbose = $PSCmdlet.MyInvocation.BoundParameters["Verbose"]
$EnableDebug = $PSCmdlet.MyInvocation.BoundParameters["Debug"]
if ($EnableVerbose -eq $null) { $EnableVerbose = $false }
if ($EnableDebug -eq $null) { $EnableDebug = $false }
if ($EnableDebug -eq $true) { $EnableVerbose = $true }
# Display help if no command was selected
$Help = $Help -or (-not ($all -or $html -or $dirhtml -or $singlehtml -or $latex -or $pdf -or $json -or $pickle -or $linkcheck -or $clean -or $help))
function Exit-Script
{ <#
.PARAMETER ExitCode
ExitCode of this script run
#>
[CmdletBinding()]
param([int]$ExitCode = 0)
# restore environment
# rm env:GHDL -ErrorAction SilentlyContinue
cd $WorkingDir
# unload modules
# Remove-Module precompile -Verbose:$false
Pop-EnvironmentBlock
# exit with exit code
exit $ExitCode
}
if ($Help)
{ Get-Help $MYINVOCATION.MyCommand.Path -Detailed
Exit-Script
}
Push-EnvironmentBlock
#$env:Path += ";C:\Tools\Graphviz\2.38\bin"
if ($All)
{ $clean = $true
$html = $true
$dirhtml = $true
$singlehtml = $true
}
$SphinxBuild = if (-not $env:SPHINXBUILD) { "sphinx-build" } else { $env:SPHINXBUILD }
# $BuildDir = "$SphinxRootDir\{{ rbuilddir }}"
# $SourceDir = "$SphinxRootDir\{{ rsrcdir }}"
$BuildDir = "$SphinxRootDir\_build" # for local testing, can be removed in the future
$SourceDir = "$SphinxRootDir\." # for local testing, can be removed in the future
$AllSphinxOpts = "-d $BuildDir\doctrees ${env:SPHINXOPTS} $SourceDir"
$I18NSphinxOpts = "${env:SPHINXOPTS} $SourceDir"
# ------------------------------------------------------------------------------
# TODO: add paper options
# ------------------------------------------------------------------------------
# if NOT "%PAPER%" == "" (
# set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
# set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
# )
# Check if sphinx-build is available and fallback to Python version if any
# ------------------------------------------------------------------------------
# TODO: add testings if sphinxbuild can be called and/or is installed
# ------------------------------------------------------------------------------
# %SPHINXBUILD% 1>NUL 2>NUL
# if errorlevel 9009 goto sphinx_python
# goto sphinx_ok
#
# :sphinx_python
#
# set SPHINXBUILD=python -m sphinx.__init__
# %SPHINXBUILD% 2> nul
# if errorlevel 9009 (
# echo.
# echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
# echo.installed, then set the SPHINXBUILD environment variable to point
# echo.to the full path of the 'sphinx-build' executable. Alternatively you
# echo.may add the Sphinx directory to PATH.
# echo.
# echo.If you don't have Sphinx installed, grab it from
# echo.http://sphinx-doc.org/
# exit /b 1
# )
if ($clean)
{ $EnableVerbose -and (Write-Host "Cleaning build directory '$BuildDir'..." -ForegroundColor DarkCyan ) | Out-Null
$EnableDebug -and (Write-Host " dir -Path $BuildDir * -Directory | rmdir -Recurse" ) | Out-Null
dir -Path $BuildDir * -Directory | rmdir -Recurse
Write-Host "Cleaning finished." -ForegroundColor Green
}
if ($html)
{ $expr = "$SphinxBuild -b html -t GHDLInternal $AllSphinxOpts $BuildDir\html"
$EnableVerbose -and (Write-Host "Building target 'html' into '$BuildDir\html'..." -ForegroundColor DarkCyan ) | Out-Null
$EnableDebug -and (Write-Host " $expr" -ForegroundColor Cyan ) | Out-Null
Invoke-Expression $expr
if ($LastExitCode -ne 0)
{ Exit-Script 1 }
Write-Host "Build finished. The HTML pages are in $BuildDir\html." -ForegroundColor Green
}
if ($dirhtml)
{ $expr = "$SphinxBuild -b dirhtml $AllSphinxOpts $BuildDir\dirhtml"
$EnableVerbose -and (Write-Host "Building target 'dirhtml' into '$BuildDir\dirhtml'..." -ForegroundColor DarkCyan ) | Out-Null
$EnableDebug -and (Write-Host " $expr" -ForegroundColor Cyan ) | Out-Null
Invoke-Expression $expr
if ($LastExitCode -ne 0)
{ Exit-Script 1 }
Write-Host "Build finished. The HTML pages are in $BuildDir\dirhtml." -ForegroundColor Green
}
if ($singlehtml)
{ $expr = "$SphinxBuild -b singlehtml $AllSphinxOpts $BuildDir\singlehtml"
$EnableVerbose -and (Write-Host "Building target 'singlehtml' into '$BuildDir\singlehtml'..." -ForegroundColor DarkCyan ) | Out-Null
$EnableDebug -and (Write-Host " $expr" -ForegroundColor Cyan ) | Out-Null
Invoke-Expression $expr
if ($LastExitCode -ne 0)
{ Exit-Script 1 }
Write-Host "Build finished. The HTML file is in $BuildDir\singlehtml." -ForegroundColor Green
}
if ($latex)
{ $expr = "$SphinxBuild -b latex $AllSphinxOpts $BuildDir\pdf"
$EnableVerbose -and (Write-Host "Building target 'latex' into '$BuildDir\pdf'..." -ForegroundColor DarkCyan ) | Out-Null
$EnableDebug -and (Write-Host " $expr" -ForegroundColor Cyan ) | Out-Null
Invoke-Expression $expr
if ($LastExitCode -ne 0)
{ Exit-Script 1 }
Write-Host "Build finished. The LaTeX sources are in $BuildDir\pdf." -ForegroundColor Green
}
if ($pdf)
{ cd "$BuildDir\pdf"
cp "$BuildDir\pdf\GHDL.tex" "$BuildDir\pdf\GHDL.tex"
$expr = "pdflatex.exe $BuildDir\pdf\GHDL.tex"
$EnableVerbose -and (Write-Host "Building target 'pdf' into '$BuildDir\pdf'..." -ForegroundColor DarkCyan ) | Out-Null
Write-Host "Compiling with pdflatex.exe..." -ForegroundColor Yellow
$EnableDebug -and (Write-Host " $expr" -ForegroundColor Cyan ) | Out-Null
Invoke-Expression $expr
if ($LastExitCode -ne 0)
{ Exit-Script 1 }
$expr = "makeindex.exe .\GHDL.idx"
Write-Host "Creating index with makeindex.exe..." -ForegroundColor Yellow
$EnableDebug -and (Write-Host " $expr" -ForegroundColor Cyan ) | Out-Null
Invoke-Expression $expr
if ($LastExitCode -ne 0)
{ Exit-Script 1 }
$expr = "pdflatex.exe $BuildDir\pdf\GHDL.tex"
Write-Host "Compiling with pdflatex.exe..." -ForegroundColor Yellow
Invoke-Expression $expr
if ($LastExitCode -ne 0)
{ Exit-Script 1 }
Write-Host "Build finished. The PDF file is in $BuildDir\pdf." -ForegroundColor Green
}
if ($pickle)
{ $expr = "$SphinxBuild -b pickle $AllSphinxOpts $BuildDir\pickle"
$EnableVerbose -and (Write-Host "Building target 'pickle' into '$BuildDir\pickle'..." -ForegroundColor DarkCyan ) | Out-Null
$EnableDebug -and (Write-Host " $expr" -ForegroundColor Cyan ) | Out-Null
Invoke-Expression $expr
if ($LastExitCode -ne 0)
{ Exit-Script 1 }
Write-Host "Build finished. Now you can process the pickle files." -ForegroundColor Green
}
if ($json)
{ $expr = "$SphinxBuild -b json $AllSphinxOpts $BuildDir\json"
$EnableVerbose -and (Write-Host "Building target 'json' into '$BuildDir\json'..." -ForegroundColor DarkCyan ) | Out-Null
$EnableDebug -and (Write-Host " $expr" -ForegroundColor Cyan ) | Out-Null
Invoke-Expression $expr
if ($LastExitCode -ne 0)
{ Exit-Script 1 }
Write-Host "Build finished. Now you can process the json files." -ForegroundColor Green
}
if ($linkcheck)
{ $expr = "$SphinxBuild -b linkcheck $AllSphinxOpts $BuildDir\linkcheck"
$EnableVerbose -and (Write-Host "Building target 'html' into '$BuildDir\html'..." -ForegroundColor DarkCyan ) | Out-Null
$EnableDebug -and (Write-Host " $expr" -ForegroundColor Cyan ) | Out-Null
Invoke-Expression $expr
if ($LastExitCode -ne 0)
{ Exit-Script 1 }
Write-Host "Link check complete. Look for any errors in the above output or in $BuildDir\linkcheck\output.txt." -ForegroundColor Green
}
Exit-Script
|
