##// END OF EJS Templates
Add autogen and html_noapi to docs make.cmd
klonuo -
Show More
@@ -7,13 +7,14 b' SET SPHINXOPTS='
7 SET SPHINXBUILD=sphinx-build
7 SET SPHINXBUILD=sphinx-build
8 SET PAPER=
8 SET PAPER=
9 SET SRCDIR=source
9 SET SRCDIR=source
10 SET PYTHON=python
10
11
11 IF "%PAPER%" == "" SET PAPER=a4
12 IF "%PAPER%" == "" SET PAPER=a4
12 SET ALLSPHINXOPTS=-d build\doctrees -D latex_paper_size=%PAPER% %SPHINXOPTS% %SRCDIR%
13 SET ALLSPHINXOPTS=-d build\doctrees -D latex_paper_size=%PAPER% %SPHINXOPTS% %SRCDIR%
13
14
14 FOR %%X IN (%SPHINXBUILD%.exe) DO SET P=%%~$PATH:X
15 FOR %%X IN (%SPHINXBUILD%.exe) DO SET P=%%~$PATH:X
15
16
16 FOR %%L IN (html pickle htmlhelp latex changes linkcheck) DO (
17 FOR %%L IN (html html_noapi pickle htmlhelp latex changes linkcheck) DO (
17 IF "%1" == "%%L" (
18 IF "%1" == "%%L" (
18 IF "%P%" == "" (
19 IF "%P%" == "" (
19 ECHO.
20 ECHO.
@@ -22,7 +23,14 b' FOR %%L IN (html pickle htmlhelp latex changes linkcheck) DO ('
22 )
23 )
23 MD build\doctrees 2>NUL
24 MD build\doctrees 2>NUL
24 MD build\%1 || GOTO DIR_EXIST
25 MD build\%1 || GOTO DIR_EXIST
25 %SPHINXBUILD% -b %1 %ALLSPHINXOPTS% build\%1
26 %PYTHON% autogen_config.py && echo "Created docs for line & cell magics"
27 %PYTHON% autogen_magics.py && echo "Created docs for config options"
28 IF NOT "%1" == "html_noapi" (
29 %PYTHON% autogen_api.py && echo "Build API docs finished."
30 %SPHINXBUILD% -b %1 %ALLSPHINXOPTS% build\%1
31 ) ELSE (
32 %SPHINXBUILD% -b html %ALLSPHINXOPTS% build\%1
33 )
26 IF NOT ERRORLEVEL 0 GOTO ERROR
34 IF NOT ERRORLEVEL 0 GOTO ERROR
27 ECHO.
35 ECHO.
28 ECHO Build finished. Results are in build\%1.
36 ECHO Build finished. Results are in build\%1.
@@ -52,13 +60,14 b' IF "%1" == "clean" ('
52 ECHO.
60 ECHO.
53 ECHO Please use "make [target]" where [target] is one of:
61 ECHO Please use "make [target]" where [target] is one of:
54 ECHO.
62 ECHO.
55 ECHO html to make standalone HTML files
63 ECHO html to make standalone HTML files
56 ECHO jsapi to make standalone HTML files for the Javascript API
64 ECHO html_noapi same as above, without the time consuming API docs
57 ECHO pickle to make pickle files (usable by e.g. sphinx-web)
65 ECHO jsapi to make standalone HTML files for the Javascript API
58 ECHO htmlhelp to make HTML files and a HTML help project
66 ECHO pickle to make pickle files (usable by e.g. sphinx-web)
59 ECHO latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
67 ECHO htmlhelp to make HTML files and a HTML help project
60 ECHO changes to make an overview over all changed/added/deprecated items
68 ECHO latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
61 ECHO linkcheck to check all external links for integrity
69 ECHO changes to make an overview over all changed/added/deprecated items
70 ECHO linkcheck to check all external links for integrity
62 GOTO END
71 GOTO END
63
72
64 :DIR_EXIST
73 :DIR_EXIST
General Comments 0
You need to be logged in to leave comments. Login now