xtensor-python/docs/make.bat at master · xtensor-stack/xtensor-python · GitHub

History

264 lines (230 loc) · 7.11 KB

Raw

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

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

@ECHO OFF

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (

set SPHINXBUILD=sphinx-build

)

set BUILDDIR=build

set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source

set I18NSPHINXOPTS=%SPHINXOPTS% source

if NOT "%PAPER%" == "" (

set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%

set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%

)

if "%1" == "" goto help

if "%1" == "help" (

:help

echo.Please use `make ^<target^>` where ^<target^> is one of

echo. html to make standalone HTML files

echo. dirhtml to make HTML files named index.html in directories

echo. singlehtml to make a single large HTML file

echo. pickle to make pickle files

echo. json to make JSON files

echo. htmlhelp to make HTML files and a HTML help project

echo. qthelp to make HTML files and a qthelp project

echo. devhelp to make HTML files and a Devhelp project

echo. epub to make an epub

echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter

echo. text to make text files

echo. man to make manual pages

echo. texinfo to make Texinfo files

echo. gettext to make PO message catalogs

echo. changes to make an overview over all changed/added/deprecated items

echo. xml to make Docutils-native XML files

echo. pseudoxml to make pseudoxml-XML files for display purposes

echo. linkcheck to check all external links for integrity

echo. doctest to run all doctests embedded in the documentation if enabled

echo. coverage to run coverage check of the documentation if enabled

goto end

)

if "%1" == "clean" (

for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i

del /q /s %BUILDDIR%\*

goto end

)

REM Check if sphinx-build is available and fallback to Python version if any

%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

)

:sphinx_ok

if "%1" == "html" (

doxygen

%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html

if errorlevel 1 exit /b 1

echo.

echo.Build finished. The HTML pages are in %BUILDDIR%/html.

goto end

)

if "%1" == "dirhtml" (

%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml

if errorlevel 1 exit /b 1

echo.

echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.

goto end

)

if "%1" == "singlehtml" (

%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml

if errorlevel 1 exit /b 1

echo.

echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.

goto end

)

if "%1" == "pickle" (

%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle

if errorlevel 1 exit /b 1

echo.

echo.Build finished; now you can process the pickle files.

goto end

)

if "%1" == "json" (

%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json

if errorlevel 1 exit /b 1

echo.

echo.Build finished; now you can process the JSON files.

goto end

)

if "%1" == "htmlhelp" (

%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp

if errorlevel 1 exit /b 1

echo.

echo.Build finished; now you can run HTML Help Workshop with the ^

.hhp project file in %BUILDDIR%/htmlhelp.

goto end

)

if "%1" == "qthelp" (

%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp

if errorlevel 1 exit /b 1

echo.

echo.Build finished; now you can run "qcollectiongenerator" with the ^

.qhcp project file in %BUILDDIR%/qthelp, like this:

echo.^> qcollectiongenerator %BUILDDIR%\qthelp\packagename.qhcp

echo.To view the help file:

echo.^> assistant -collectionFile %BUILDDIR%\qthelp\packagename.ghc

goto end

)

if "%1" == "devhelp" (

%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp

if errorlevel 1 exit /b 1

echo.

echo.Build finished.

goto end

)

if "%1" == "epub" (

%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub

if errorlevel 1 exit /b 1

echo.

echo.Build finished. The epub file is in %BUILDDIR%/epub.

goto end

)

if "%1" == "latex" (

%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex

if errorlevel 1 exit /b 1

echo.

echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.

goto end

)

if "%1" == "latexpdf" (

%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex

cd %BUILDDIR%/latex

make all-pdf

cd %~dp0

echo.

echo.Build finished; the PDF files are in %BUILDDIR%/latex.

goto end

)

if "%1" == "latexpdfja" (

%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex

cd %BUILDDIR%/latex

make all-pdf-ja

cd %~dp0

echo.

echo.Build finished; the PDF files are in %BUILDDIR%/latex.

goto end

)

if "%1" == "text" (

%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text

if errorlevel 1 exit /b 1

echo.

echo.Build finished. The text files are in %BUILDDIR%/text.

goto end

)

if "%1" == "man" (

%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man

if errorlevel 1 exit /b 1

echo.

echo.Build finished. The manual pages are in %BUILDDIR%/man.

goto end

)

if "%1" == "texinfo" (

%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo

if errorlevel 1 exit /b 1

echo.

echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.

goto end

)

if "%1" == "gettext" (

%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale

if errorlevel 1 exit /b 1

echo.

echo.Build finished. The message catalogs are in %BUILDDIR%/locale.

goto end

)

if "%1" == "changes" (

%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes

if errorlevel 1 exit /b 1

echo.

echo.The overview file is in %BUILDDIR%/changes.

goto end

)

if "%1" == "linkcheck" (

%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck

if errorlevel 1 exit /b 1

echo.

echo.Link check complete; look for any errors in the above output ^

or in %BUILDDIR%/linkcheck/output.txt.

goto end

)

if "%1" == "doctest" (

%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest

if errorlevel 1 exit /b 1

echo.

echo.Testing of doctests in the sources finished, look at the ^

results in %BUILDDIR%/doctest/output.txt.

goto end

)

if "%1" == "coverage" (

%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage

if errorlevel 1 exit /b 1

echo.

echo.Testing of coverage in the sources finished, look at the ^

results in %BUILDDIR%/coverage/python.txt.

goto end

)

if "%1" == "xml" (

%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml

if errorlevel 1 exit /b 1

echo.

echo.Build finished. The XML files are in %BUILDDIR%/xml.

goto end

)

if "%1" == "pseudoxml" (

%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml

if errorlevel 1 exit /b 1

echo.

echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.

goto end

)

:end

xtensor-python/docs/make.bat at master · xtensor-stack/xtensor-python · GitHub

Uh oh!

Expand file tree

Breadcrumbs

make.bat

Latest commit

History

Breadcrumbs

make.bat

File metadata and controls