official-devguide-python/make.bat at main · starseeker-code/official-devguide-python · GitHub

History

236 lines (203 loc) · 6.15 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

@ECHO OFF

REM Command file for Sphinx documentation

setlocal

pushd %~dp0

if "%PYTHON%" == "" (

set PYTHON=py -3

)

if not defined SPHINXLINT (

%PYTHON% -c "import sphinxlint" > nul 2> nul

if errorlevel 1 (

echo Installing sphinx-lint with %PYTHON%

rem Should have been installed with Sphinx earlier

%PYTHON% -m pip install "sphinx-lint<1"

if errorlevel 1 exit /B

)

set SPHINXLINT=%PYTHON% -m sphinxlint

)

set BUILDDIR=_build

set SPHINXOPTS=-W --keep-going -n

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

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

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

)

if "%1" == "check" goto check

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. htmlview to open the index page built by the html target in your browser

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. changes to make an overview over all changed/added/deprecated items

echo. linkcheck to check all external links for integrity

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

echo. check to check for stylistic and formal issues using sphinx-lint

goto end

)

if "%1" == "clean" (

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

del /q /s %BUILDDIR%\*

goto end

)

rem Targets other than "clean", "check", "help", or "" need the

rem Sphinx build command, which the user may define via SPHINXBUILD.

if not defined SPHINXBUILD (

rem If it is not defined, we build in a virtual environment

if not exist venv (

echo. Setting up the virtual environment

%PYTHON% -m venv venv

echo. Installing requirements

venv\Scripts\python -m pip install -r requirements.txt

)

set PYTHON=venv\Scripts\python

set SPHINXBUILD=venv\Scripts\sphinx-build

)

if "%1" == "html" (

%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" == "htmlview" (

cmd /C %this% html

if EXIST "%BUILDDIR%\html\index.html" (

echo.Opening "%BUILDDIR%\html\index.html" in the default web browser...

start "" "%BUILDDIR%\html\index.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\PythonDevelopersGuide.qhcp

echo.To view the help file:

echo.^> assistant -collectionFile %BUILDDIR%\qthelp\PythonDevelopersGuide.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" == "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" == "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

)

:check

rem Ignore the tools and venv dirs and check that the default role is not used.

cmd /S /C "%SPHINXLINT% -i tools -i venv --enable default-role"

goto end

:serve

echo.The serve target was removed, use htmlview instead ^

(see https://github.com/python/cpython/issues/80510)

goto end

if "%1" == "versions" (

%PYTHON% _tools/generate_release_cycle.py

if errorlevel 1 exit /b 1

echo.

echo Release cycle data generated.

goto end

)

:end

popd

endlocal

official-devguide-python/make.bat at main · starseeker-code/official-devguide-python · GitHub

Expand file tree

Breadcrumbs

make.bat

Latest commit

History

Breadcrumbs

make.bat

File metadata and controls