ó öÀ„\c@s dZddlmZddlZddlZddlmZddlmZm Z ddl m Z m Z ddl mZddlmZdd lmZmZdd lmZmZdd lmZerñdd lmZmZmZmZnd efd„ƒYZdS(s? sphinx.setup_command ~~~~~~~~~~~~~~~~~~~~ Setuptools/distutils commands to assist the building of sphinx documentation. :author: Sebastian Wiesner :contact: basti.wiesner@gmx.net :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. iÿÿÿÿ(tprint_functionN(tCommand(tDistutilsOptionErrortDistutilsExecError(tStringIOt string_types(tSphinx(thandle_exception(tnocolortcolor_terminal(tdocutils_namespacetpatch_docutils(tabspath(tAnytDicttListtTupletBuildDoccBsŒeZdZdZd-d.d/d1d2d3d4d5d6d7d8d9d:d;d<gZddddd%gZd(„Zd)„Zd0d*„Z d+„Z d,„Z RS(=s7 Distutils command to build Sphinx documentation. The Sphinx build can then be triggered from distutils, and some Sphinx options can be set in ``setup.py`` or ``setup.cfg`` instead of Sphinx own configuration file. For instance, from `setup.py`:: # this is only necessary when not using setuptools/distribute from sphinx.setup_command import BuildDoc cmdclass = {'build_sphinx': BuildDoc} name = 'My project' version = '1.2' release = '1.2.0' setup( name=name, author='Bernard Montgomery', version=release, cmdclass=cmdclass, # these are optional and override conf.py settings command_options={ 'build_sphinx': { 'project': ('setup.py', name), 'version': ('setup.py', version), 'release': ('setup.py', release)}}, ) Or add this section in ``setup.cfg``:: [build_sphinx] project = 'My project' version = 1.2 release = 1.2.0 sBuild Sphinx documentations fresh-envtEsdiscard saved environments all-filestasbuild all filess source-dir=tssSource directorys build-dir=sBuild directorys config-dir=tcs'Location of the configuration directorysbuilder=tbs]The builder (or builders) to use. Can be a comma- or space-separated list. Defaults to "html"swarning-is-errortWsTurn warning into errorssproject=sThe documented project's namesversion=sThe short X.Y versionsrelease=s.The full version, including alpha/beta/rc tagsstoday=sCHow to format the current date, used as the replacement for |today|s link-indextis!Link index.html to the master doct copyrightsThe copyright stringtpdbsStart pdb on exceptiontnitpickytns1nit-picky mode, warn about all missing referencescCs™t|_|_t|_d|_|_d|_t|_d|_ d|_ d|_ d|_ d|_ t|_d|_d|_t|_t|_dS(Nthtmlti(tFalset fresh_envt all_filesRtNonet source_dirt build_dirtbuildertwarning_is_errortprojecttversiontreleasettodayt config_dirt link_indexRt verbosityt tracebackR(tself((s3lib/python2.7/site-packages/sphinx/setup_command.pytinitialize_options_s            cCscxYdD]Q}tjj|ƒs%qnx0tj|ƒD]\}}}d|kr5|Sq5WqWtjS(Ntdoctdocssconf.py(R1R2(tostpathtisdirtwalktcurdir(R/tguesstroottdirnamest filenames((s3lib/python2.7/site-packages/sphinx/setup_command.pyt_guess_source_dirqs   cCs^t||ƒ}|dkr/t|||ƒ|St|tƒsZtd|||fƒ‚n|S(Ns'%s' must be a %s (got `%s`)(tgetattrR"tsetattrt isinstanceRR(R/toptiontwhattdefaulttval((s3lib/python2.7/site-packages/sphinx/setup_command.pyt_ensure_stringlike~s cCs|jdƒ|jdkrB|jƒ|_|jd|jƒn|jdƒ|jdkrm|j|_n|jdkr¯|jdƒ}t j j t |j ƒdƒ|_nt j j |jdƒ|_g|jD]$}|t j j |j|ƒf^qÔ|_dS(NR%sUsing source directory %sR#tbuildtsphinxtdoctrees(tensure_string_listR#R"R<tannouncetensure_dirnameR+R$tget_finalized_commandR3R4tjoinR t build_baset doctree_dirR%tbuilder_target_dirs(R/RER%((s3lib/python2.7/site-packages/sphinx/setup_command.pytfinalize_options‰s  $c Cs#tƒstƒn|js(tƒ}n tj}i}|jrP|j|d s  %