python 文档生成器 sphinx

1.安装下载
https://pypi.python.org/packages/source/S/Sphinx/Sphinx-1.2.1.tar.gz#md5=104494f036889122c9f403ae065ae7a9

将下载的内容加压缩 ，加压完后，使用python 安装
打开CMD窗口，cd 到加压缩目录 ,执行python setup.py install

2.安装完后开始使用，以生成splinter的doc为类，进入splinter doc目录 有一个make.bat文件

使用editplus 将其打开

@ECHO OFFREM Command file for Sphinx documentationif "%SPHINXBUILD%" == "" (    set SPHINXBUILD=sphinx-build)set BUILDDIR=_buildset ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .if NOT "%PAPER%" == "" (    set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%)if "%1" == "" goto helpif "%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.  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    goto end)if "%1" == "clean" (    for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i    del /q /s %BUILDDIR%\*    goto end)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" == "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\splinter.qhcp    echo.To view the help file:    echo.^> assistant -collectionFile %BUILDDIR%\qthelp\splinter.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):end

在代码的第5行 SPHINXBUILD，因此需要设置sphinx-build 环境变量

3.设置sphinx-build 环境变量

找到 C:\Python27\Scripts\sphinx-build.exe

将其添加为SPHINXBUILD坏境变量的值

4.生成 doc文档

make.bat html