annotate doc/make.bat @ 421:f124ed5ea78b

doc: remove python2 references + added a warning for `python setup.py install`
author Goffi <goffi@goffi.org>
date Sat, 22 Feb 2020 13:06:51 +0100
parents 105a0772eedd
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
404
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
1 @ECHO OFF
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
2
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
3 pushd %~dp0
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
4
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
5 REM Command file for Sphinx documentation
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
6
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
7 if "%SPHINXBUILD%" == "" (
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
8 set SPHINXBUILD=sphinx-build
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
9 )
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
10 set SOURCEDIR=.
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
11 set BUILDDIR=.build
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
12
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
13 if "%1" == "" goto help
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
14
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
15 %SPHINXBUILD% >NUL 2>NUL
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
16 if errorlevel 9009 (
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
17 echo.
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
18 echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
19 echo.installed, then set the SPHINXBUILD environment variable to point
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
20 echo.to the full path of the 'sphinx-build' executable. Alternatively you
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
21 echo.may add the Sphinx directory to PATH.
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
22 echo.
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
23 echo.If you don't have Sphinx installed, grab it from
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
24 echo.http://sphinx-doc.org/
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
25 exit /b 1
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
26 )
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
27
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
28 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
29 goto end
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
30
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
31 :help
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
32 %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
33
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
34 :end
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
35 popd