B \4@sbdZddlmZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z m Z ddlZddlmZmZddlmZddlmZdd lmZdd lmZmZmZdd lmZmZmZdd lm Z m!Z!dd l"m#Z#ej$fddZ%ddZ&ddZ'ej(ddfddZ)ej(ddfddZ*ej(ddfddZ+e,dkr^e-e+ej(dddS)z sphinx.cmd.build ~~~~~~~~~~~~~~~~ Build documentation from a provided source. :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. )print_functionN) SystemMessage) text_type binary_type)__display_version__ package_dir)Sphinx) SphinxError)__)Teeformat_exception_cut_framessave_traceback)rednocolorcolor_terminal)docutils_namespacepatch_docutils) terminal_safecCs(|jr@ddl}tttd|dt|tdnt|d|j sV|jrltd|t|dt |t rttd|dnt |t rtttd|dtt |jd|dnbt |trttd|j|dtt t||dn*t |trPtttd|dtt t||dt|}tttd ||dnt |trd t|krtttd |dtt t||dt|dttd |dttd |dnftttd|dtt|dt|}tttd ||dttd|dttd|ddS)Nrz5Exception occurred while building, starting debugger:)filez interrupted!zreST markup error:z%s:zEncoding error:z[The full traceback has been saved in %s, if you want to report the issue to the developers.zrecursion depthzRecursion error:zThis can happen with very large or deeply nested source files. You can carefully increase the default Python recursion limit of 1000 in conf.py with e.g.:z+ import sys; sys.setrecursionlimit(1500)zException occurred:ziPlease also report this if it was a user error, so that a better error message can be provided next time.zbA bug report can be filed in the tracker at . Thanks!)pdbprintrr traceback print_excZ post_mortemsysexc_info verbosity isinstanceKeyboardInterruptrrargsr categoryr UnicodeErrorr RuntimeErrorstrr rstrip)apprZ exceptionstderrrZtbpathr'/lib/python3.7/site-packages/sphinx/cmd/build.pyhandle_exception&sT             r)cCs8|dkrtSt|}|dkr0ttdn|SdS)z Special type to handle 'auto' flags passed to 'sphinx-build' via -j flag. Can be expanded to handle other special scaling requests, such as setting job count to cpu_count. autorz&job number should be a positive numberN)multiprocessing cpu_countintargparseZArgumentTypeErrorr )valuejobsr'r'r( jobs_argumentYs r1cCsxtjdtdtdd}|jddddtd |jd td d |jd tdd |jddtdd|td}|jddddtdd|jdddtdd|jddd td!d|jd"d#d$td%d&|jd'd(d)td*td+d,|d-}|jd.d#d/td0d&|jd1dd2td3d|jd4d5d6d7gtd8d9|jd:d;d6dd?d6d@gtdAd9|jdBddCtdDd|tdE}|jdFdGdHdItdJdK|jdLddMtdNd|jdOddPtdQd|jdRdSdTdUtdVdW|jdXdYdZdSd[td\d]|jd^d_d`tdad&|jdbddctddd|jdeddftdgd|jdhdditdjd|jdkddltdmd|S)nNz5%(prog)s [OPTIONS] SOURCEDIR OUTPUTDIR [FILENAMES...]z5For more information, visit .a Generate documentation from source files. sphinx-build generates documentation from the files in SOURCEDIR and places it in OUTPUTDIR. It looks for 'conf.py' in SOURCEDIR for the configuration settings. The 'sphinx-quickstart' tool may be used to generate template files, including 'conf.py' sphinx-build can create documentation in different formats. A format is selected by specifying the builder name on the command line; it defaults to HTML. Builders can also perform other tasks related to documentation processing. By default, everything that is outdated is built. Output only for selected files can be built by specifying individual filenames. )ZusageZepilogZ descriptionz --versionversionZ show_versionz %%(prog)s %s)actiondestr2 sourcedirz"path to documentation source files)help outputdirzpath to output directory filenames*z?a list of specific files to rebuild. Ignored if -a is specified)nargsr6zgeneral optionsz-bZBUILDERbuilderZhtmlzbuilder to use (default: html))metavarr4defaultr6z-a store_true force_allz;write all files (default: only write new and changed files))r3r4r6z-Efreshenvz4don't use a saved environment, always read all filesz-dPATH doctreedirzPpath for the cached environment and doctree files (default: OUTPUTDIR/.doctrees))r<r4r6z-jNr0z`build in parallel with N processes where possible (special value "auto" will set N to cpu-count))r<r=typer4r6zbuild configuration optionsz-cconfdirzOpath where configuration file (conf.py) is located (default: same as SOURCEDIR)z-Cnoconfigz*use no config file at all, only -D optionsz-Dz setting=valueappenddefinez(override a setting in configuration file)r<r3r4r=r6z-Az name=value htmldefinez pass a value into HTML templatesz-tZTAGtagsz*define tag: include "only" blocks with TAGz-nnitpickyz1nit-picky mode, warn about all missing referenceszconsole output optionsz-vcountrrz$increase verbosity (can be repeated))r3r4r=r6z-qquietz,no output on stdout, just warnings on stderrz-Q really_quietz#no output at all, not even warningsz--colorZ store_constZyesr*z-do emit colored output (default: auto-detect))r3constr=r6z-Nz --no-colorcolornoz1do not emit colored output (default: auto-detect))r4r3rPr6z-wZFILEwarnfilez)write warnings (and errors) to given filez-Wwarningiserrorzturn warnings into errorsz --keep-going keep_goingz)With -W, Keep going when getting warningsz-Trz show full traceback on exceptionz-Przrun Pdb on exception)r.ArgumentParserr add_argumentrZadd_argument_groupr1)parsergroupr'r'r( get_parserjs                                                rZrDcCsddlm}||ddS)zSphinx build "make mode" entry.r) make_moderDN)Z sphinx.cmdr[Z run_make_mode)argvr[r'r'r( make_mains r]cCst}||}|jrd|_n|js,|j|_|jsDtj|j d|_|j }g}x"|D]}tj |sT| |qTW|r| td|ytd}|}Wntk rd}YnX|jr|r| td|jdks|jdkrtsttj}tj} tj} |jr d}|jrd}} | r|jryt|jd} Wn<tk rv} z| td |j| fWdd} ~ XYnXt| | } | } i} x|jD]}y|d d \}}Wn$t k r| td YnX|rt!|t"ry|#|}Wnt$k rYnX|| |<qWx|j%D]}y|d \}}Wn$t k rX| td YnXy t&|}WnNt k r|rt!|t"ry|#|}Wnt$k rYnXYnX|| d|<qW|j'rd| d<d}y|jp|j}t(|`t)Nt*|j|j|j |j|j+| || |j,|j-|j.|j/|j0|j1}|2|j||j3SQRXWdQRXWn6tt4fk r} zt5||| | dSd} ~ XYnXdS)z'Sphinx build "main" command-line entry.Nz .doctreeszcannot find files %rlocalez&cannot combine -a option and filenamesrRr*wzcannot open warning file %r: %s=rDz1-D option argument must be in the form name=valuez1-A option argument must be in the form name=valuezhtml_context.%sTrLr)6rZ parse_argsrGrFr5rBospathjoinr7r8isfilerHerrorr __import__Zgetpreferredencoding Exceptionr?rQrrrstdoutr&rNrOrSopenr rIsplit ValueErrorrrdecoder!rJr-rLrrrr;r@rTrKrr0rUZbuildZ statuscoderr))r\rXrr8Z missing_filesfilenamer^Zlikely_encodingZstatusZwarningrfZwarnfpexcZ confoverridesvalkeyr%rFr'r'r( build_mains               rrcCsNtjtjdtjtjtdd|dddgkrBt |St |SdS)Nr^sphinxrDz-M) rtr^ setlocaleLC_ALLZ init_consolerbrcrdrr]rr)r\r'r'r(main7s rw__main__).__doc__Z __future__rr.r^r+rbrrZdocutils.utilsrZsixrrZ sphinx.localertrrZsphinx.applicationrZ sphinx.errorsr r Z sphinx.utilr r r Zsphinx.util.consolerrrZsphinx.util.docutilsrrZsphinx.util.pycompatrr&r)r1rZr\r]rrrw__name__exitr'r'r'r( s4      3`f