##// END OF EJS Templates
Add autogen and html_noapi to docs make.cmd
klonuo -
Show More
@@ -1,73 +1,82 b''
1 1 @ECHO OFF
2 2 REM ~ Windows command line make file for Sphinx documentation
3 3
4 4 SETLOCAL
5 5
6 6 SET SPHINXOPTS=
7 7 SET SPHINXBUILD=sphinx-build
8 8 SET PAPER=
9 9 SET SRCDIR=source
10 SET PYTHON=python
10 11
11 12 IF "%PAPER%" == "" SET PAPER=a4
12 13 SET ALLSPHINXOPTS=-d build\doctrees -D latex_paper_size=%PAPER% %SPHINXOPTS% %SRCDIR%
13 14
14 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 18 IF "%1" == "%%L" (
18 19 IF "%P%" == "" (
19 20 ECHO.
20 21 ECHO Error: Sphinx is not available. Please make sure it is correctly installed.
21 22 GOTO END
22 23 )
23 24 MD build\doctrees 2>NUL
24 25 MD build\%1 || GOTO DIR_EXIST
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."
25 30 %SPHINXBUILD% -b %1 %ALLSPHINXOPTS% build\%1
31 ) ELSE (
32 %SPHINXBUILD% -b html %ALLSPHINXOPTS% build\%1
33 )
26 34 IF NOT ERRORLEVEL 0 GOTO ERROR
27 35 ECHO.
28 36 ECHO Build finished. Results are in build\%1.
29 37 IF "%1" == "pickle" (
30 38 ECHO Now you can process the pickle files or run
31 39 ECHO sphinx-web build\pickle to start the sphinx-web server.
32 40 )
33 41 IF "%1" == "htmlhelp" (
34 42 ECHO Now you can run HTML Help Workshop with the
35 43 ECHO .hhp project file in build/htmlhelp.
36 44 )
37 45 IF "%1" == "linkcheck" (
38 46 ECHO Look for any errors in the above output
39 47 ECHO or in build\linkcheck\output.rst.
40 48 )
41 49 GOTO END
42 50 )
43 51 )
44 52
45 53
46 54 IF "%1" == "clean" (
47 55 RD /s /q build dist %SRCDIR%\api\generated 2>NUL
48 56 IF ERRORLEVEL 0 ECHO Build environment cleaned!
49 57 GOTO END
50 58 )
51 59
52 60 ECHO.
53 61 ECHO Please use "make [target]" where [target] is one of:
54 62 ECHO.
55 63 ECHO html to make standalone HTML files
64 ECHO html_noapi same as above, without the time consuming API docs
56 65 ECHO jsapi to make standalone HTML files for the Javascript API
57 66 ECHO pickle to make pickle files (usable by e.g. sphinx-web)
58 67 ECHO htmlhelp to make HTML files and a HTML help project
59 68 ECHO latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
60 69 ECHO changes to make an overview over all changed/added/deprecated items
61 70 ECHO linkcheck to check all external links for integrity
62 71 GOTO END
63 72
64 73 :DIR_EXIST
65 74 ECHO.
66 75 ECHO Info: Run "make clean" to clean build environment
67 76
68 77 :ERROR
69 78 ECHO.
70 79 ECHO Error: Build process failed!
71 80
72 81 :END
73 82 ENDLOCAL No newline at end of file
General Comments 0
You need to be logged in to leave comments. Login now