ó öÀ„\c @@sOdZddlmZddlmZddlZddlZddlZddlZddlZddl Z ddl m Z ddl m Z ddlmZyQddlZejrÛdejkrÛejd ƒeZnejd ƒeZWnek reZnXdd lmZdd lmZmZmZmZdd lmZddlmZ ddl!Z"ddl"m#Z#m$Z$ddl!m%Z%ddl&m'Z'ddl(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.ddl/m0Z0m1Z1ddl2m3Z3er(ddl4m5Z5m6Z6m7Z7m8Z8m9Z9m:Z:ne;ej<ddƒZ>e de%dƒfde%dƒfde%dƒfde%dƒfde%d ƒfd!e%d"ƒfd#e%d$ƒfd%e%d&ƒfd'e%d(ƒfd)e%d*ƒfg ƒZ?id+d,6ed-6d.d/6dd06d1d26d3d46ed56ed66Z@d7ZAejBd8kr;d9ZCnd:ZCd;„ZDd<eEfd=„ƒYZFd>„ZGd?„ZHd@„ZIdA„ZJdB„ZKdC„ZLdD„ZMdE„ZNdeIdF„ZOejPdGƒdH„ZQdIe3fdJ„ƒYZRdK„ZSeeddL„ZTdM„ZUdN„ZVejWdOdP„ZXeYdQkrKejZeXejWdOƒƒndS(Rsä sphinx.cmd.quickstart ~~~~~~~~~~~~~~~~~~~~~ Quickly setup documentation source to work with Sphinx. :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. i(tabsolute_import(tprint_functionN(t OrderedDict(topen(tpathtlibeditsbind ^I rl_completes tab: complete(t column_width(tPY2tPY3t text_typet binary_type(tinput(tquote(t__display_version__t package_dir(t__(t texescape(tcolorizetboldtredt turquoisetnocolortcolor_terminal(t ensuredirt make_filename(tSphinxRenderer(tAnytCallabletDicttListtPatterntUniontencodingtautodocs,automatically insert docstrings from modulestdoctests2automatically test code snippets in doctest blockst intersphinxs7link between Sphinx documentation of different projectsttodos9write "todo" entries that can be shown or hidden on buildtcoverages!checks for documentation coveragetimgmaths+include math, rendered as PNG or SVG imagestmathjaxs0include math, rendered in the browser by MathJaxtifconfigs7conditional inclusion of content based on config valuestviewcodes=include links to the source code of documented Python objectst githubpagess=create .nojekyll file to publish the document on GitHub pagest.Rtsept_tdottlanguages.rsttsuffixtindextmastertmakefilet batchfiles> twin32RtpurplecC@s7tjdkr)t|ddƒtdƒSt|ƒSdS(NR5tendt(tsystplatformtprintR (tprompt((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pyt term_input]s tValidationErrorcB@seZdZRS(sRaised for validation errors.(t__name__t __module__t__doc__(((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pyR>iscC@sGtj|ƒ}tj|ƒrCtj|ƒ rCttdƒƒ‚n|S(NsPlease enter a valid path name.(Rt expandusertexiststisdirR>R(tx((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pytis_pathmscC@s|S(N((RE((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pyt allow_emptyuscC@s|sttdƒƒ‚n|S(NsPlease enter some text.(R>R(RE((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pytnonemptyzsc@s‡fd†}|S(Nc@s2|ˆkr.ttdƒdjˆƒƒ‚n|S(NsPlease enter one of %s.s, (R>Rtjoin(RE(tl(s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pytvalƒs "((RJRK((RJs4lib/python2.7/site-packages/sphinx/cmd/quickstart.pytchoicescC@s7|jƒdkr'ttdƒƒ‚n|jƒdkS(NtYtYEStNtNOsPlease enter either 'y' or 'n'.(RMRNRORP(RMRN(tupperR>R(RE((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pytboolean‹scC@s>|dd!dko"t|ƒdks:ttdƒƒ‚n|S(NiiR+s2Please enter a file suffix, e.g. '.rst' or '.txt'.(tlenR>R(RE((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pyR0’s%cC@s|S(N((RE((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pytokšscC@s t|tƒr|Str&|jtƒS|jddƒjddƒ|krW|jdƒStttdƒƒƒy|jdƒSWntk r›|jdƒSXdS(Ntasciitreplaces`* Note: non-ASCII characters entered and terminal encoding unknown -- assuming UTF-8 or Latin-1.sutf-8tlatin1( t isinstanceR t TERM_ENCODINGtdecodetencodeR;RRtUnicodeDecodeError(ttext((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pyt term_decodeŸs $  cC@slxetrg|dk r,td||f}nt|d}trÎ|jddƒjddƒ|krÎtr||jtƒ}qËttt dƒƒƒy|jdƒ}WqËt k rÇ|jdƒ}qËXqÎnt r×nt t |dtƒ}t|ƒjƒ}|r| r|}nt|ƒ}y||ƒ}Wn0tk rb}ttd t|ƒƒƒqnXPqW|S( Ns %s [%s]: s: RURVsd* Note: non-ASCII default value provided and terminal encoding unknown -- assuming UTF-8 or Latin-1.sutf-8RWt input_modes* (tTruetNonet PROMPT_PREFIXRR[RZRYR;RRtUnicodeEncodeErrort USE_LIBEDITRtCOLOR_QUESTIONR=tstripR^R>Rtstr(R]tdefaultt validatorR<REterr((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pyt do_promptµs8       s [uU]('.*?')cC@str|jd|ƒS|SdS(Ns\1(Rtsub(tsourcetrex((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pytconvert_python_sourceÞstQuickstartRenderercB@seZd„Zd„ZRS(cC@s&|p d|_tt|ƒjƒdS(NR8(t templatedirtsuperRpt__init__(tselfRq((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pyRsèscC@sctj|jtj|ƒƒ}|jrFtj|ƒrF|j||ƒStt|ƒj||ƒSdS(N( RRIRqtbasenameRCtrender_from_fileRrRptrender(Rtt template_nametcontextt user_template((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pyRwís(R?R@RsRw(((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pyRpçs cC@s&tttdƒƒtƒttdƒƒd|krWtttdƒ|dƒƒn,ttdƒƒttdƒdtƒ|ds4Ask the user for quickstart values missing from *d*. Values are: * path: root path * sep: separate source and build dirs (bool) * dot: replacement for dot in _templates etc. * project: project name * author: author names * version: version of project * release: release of project * language: document language * suffix: source file suffix * master: master document name * extensions: extensions to use (list) * makefile: make Makefile * batchfile: make command file s,Welcome to the Sphinx %s quickstart utility.sz Please enter values for the following settings (just press Enter to accept a default value, if one is given in brackets).Rs Selected root path: %ss' Enter the root path for documentation.sRoot path for the documentationR+sconf.pyRmsDError: an existing conf.py has been found in the selected root path.s>sphinx-quickstart will not overwrite existing Sphinx projects.s4Please enter a new root path (or just Enter to exit)R8iR,sÊ You have two options for placing the build directory for Sphinx output. Either, you use a directory "_build" within the root path, or you separate "source" and "build" directories within the root path.s+Separate source and build directories (y/n)tnR.së Inside the root directory, two more directories will be created; "_templates" for custom HTML templates and "_static" for custom stylesheets and other static files. You can enter another prefix (such as ".") to replace the underscore.s(Name prefix for templates and static dirR-tprojectsJ The project name will occur in several places in the built documentation.s Project nametauthorsAuthor name(s)tversions/ Sphinx has the notion of a "version" and a "release" for the software. Each version can have multiple releases. For example, for Python the version is something like 2.5 or 3.0, while the release is something like 2.5.1 or 3.0a1. If you don't need this dual structure, just set both to the same value.sProject versiontreleasesProject releaseR/s If the documents are to be written in a language other than English, you can select a language here by its language code. Sphinx will then translate text that it generates into that language. For a list of supported codes, see http://sphinx-doc.org/config.html#confval-language.sProject languagetenR0s‰ The file name suffix for source files. Commonly, this is either ".txt" or ".rst". Only files with this suffix are considered documents.sSource file suffixs.rstR2s One document is special in that it is considered the top node of the "contents tree", that is, it is the root of the hierarchical structure of the documents. Normally, this is "index", but if your "index" document is a custom template, you can also set this to another filename.s-Name of your master document (without suffix)R1sKError: the master file %s has already been found in the selected root path.s7sphinx-quickstart will not overwrite the existing file.sIPlease enter a new file name, or rename the existing file and press Entert extensionssDIndicate which of the following Sphinx extensions should be enabled:s %s: %s (y/n)s sphinx.ext.%sssphinx.ext.imgmathssphinx.ext.mathjaxsZNote: imgmath and mathjax cannot be enabled at the same time. imgmath has been deselected.R3s˜ A Makefile and a Windows command file can be generated for you so that you only have to run e.g. `make html' instead of invoking sphinx-build directly.sCreate Makefile? (y/n)tyR4s"Create Windows command file? (y/n)N(R;RRR RkRFRtisfileRIR9texitRRRTRGRaR0t EXTENSIONStitemstappendtsettissubsettremove(tdtnamet description((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pytask_userös¤    ""             #       ..        c @s+td|ƒ}tjƒdˆkr2dˆdƒn|r¸d-St"ƒt"t#t$d?ƒƒƒt"t$d@ƒ| ˆd6sùˆd<rt$dAƒpt$dBƒ||ft$dCƒƒd-S(Es(Generate project based on values in *d*.Rqt mastertoctreeR8tmastertocmaxdepthiRR|t project_fntidnat project_urltproject_manpagetnowt=tproject_underlineRs%Ys, R}t copyrighttauthor_texescapeds Documentationt project_doctproject_doc_texescapedR~RR2s\s\\t's\'t_strRR,Rmtbuildtexclude_patternsR.s Thumbs.dbs .DS_Storet templateststaticc@s”ˆstj|ƒ rmdˆkr9ttdƒ|ƒnt|dddd|ƒ}|j|ƒWdQXn#dˆkrttdƒ|ƒndS(NtquietsCreating file %s.twtR sutf-8tnewlines!File %s already exists, skipping.(RRƒR;RRtwrite(tfpathtcontentR¤tf(R‹t overwrite(s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pyt write_file»s  s conf.py_tt quickstartNsconf.pyR0squickstart/master_doc.rst_tt make_modesquickstart/Makefile.new_tsquickstart/make.bat.new_tsquickstart/Makefile_tsquickstart/make.bat_tR3R+trsrcdirt rbuilddirtMakefileu R4smake.batu s:Finished: An initial directory structure has been created.sZ You should now populate your master file %s and create other documentation source files. s=Use the Makefile to build the docs, like so: make builder sZUse the sphinx-build command to build the docs, like so: sphinx-build -b builder %s %s sQwhere "builder" is one of the supported builders, e.g. html, latex or linkcheck. ( R|RšR›R}R™R˜R~RR2(%RpRtinitRRturlquoteR[tlowerttimetasctimeRt setdefaulttstrftimeR t translatettex_escape_mapRVRRDRRItmaptreprRatosRƒRRRotreadt render_stringRwtgetR`R;RR(R‹R©tsilentRqttemplatetkeytsrcdirtbuilddirRŸRªt conf_pathR¨t conf_textt masterfiletmakefile_templatetbatchfile_template((R‹R©s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pytgenerate†sŠ       .*      !% ""DcC@sö|d}tj|ƒstStj|ƒs0tStddgƒttj|ƒƒ@rYtS|dr¡tjjd|ƒ}tj|ƒs‹tStj|ƒs¡tSnd|dd|dd |d |d g}t|ƒttj|ƒƒ@ròtStS( NRR¯smake.batR,Rmsconf.pyR.R¡R R2R0( RRCR`RDtFalseRˆR»tlistdirRI(R‹tdirtreserved_names((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pyt valid_dirös( %   c C@sAtjdddtdƒdtdƒƒ}|jddd d d d d ddtdƒƒ|jdd dd dddtƒ|jdddd ddddtdƒƒ|jtdƒƒ}|jdd d d ddtdƒƒ|jddddtd ƒƒ|jtd!ƒƒ}|jd"d#dd$d d%dtd&ƒƒ|jd'd(dd)d d*dtd+ƒƒ|jd,dd-d dd d.dtd/ƒƒ|jd0d1dd2d d3dtd4ƒƒ|jd5d6dd7d d8dtd9ƒƒ|jd:dd;dtd<ƒƒ|jd=dd>dtd?ƒƒ|jd@d d d tdtdAƒƒ|jtdBƒƒ}xEtD]=}|jdC|d dDdEdF|d dGdtdHƒ|ƒq^W|jdIddJd dGd dKdtdLƒƒ|jtdMƒƒ}|jdNd d d dOd ddtdPƒƒ|jdQd dRd dOdtdSƒƒ|jdTd d d dUd ddtdVƒƒ|jdWd dRd dUdtdXƒƒ|jdYdZd d d d[d t dtd\ƒƒ|jd]d^d dRd d[dtd_ƒƒ|jtd`ƒƒ}|jdadbddcd dddtdeƒƒ|jdfddgd dKd dhdtdiƒƒ|S(jNtusages %(prog)s [OPTIONS] tepilogs5For more information, visit .Rsí Generate required files for a Sphinx project. sphinx-quickstart is an interactive tool that asks some questions about your project and then generates a complete documentation directory and sample Makefile to be used with sphinx-build. s-qs--quiettactiont store_truetdestR¢Rhthelps quiet modes --versionR~t show_versions %%(prog)s %sRtmetavart PROJECT_DIRR+tnargst?s output pathsStructure optionss--seps,if specified, separate source and build dirss--dottDOTs&replacement for dot in _templates etc.sProject basic optionss-ps --projecttPROJECTR|s project names-as--authortAUTHORR}s author namess-vtVERSIONR8sversion of projects-rs --releasetRELEASERsrelease of projects-ls --languagetLANGUAGER/sdocument languages--suffixtSUFFIXssource file suffixs--mastertMASTERsmaster document names--epubsuse epubsExtension optionss--ext-%st append_consttconsts sphinx.ext.%sRsenable %s extensions --extensionsR…R‡senable arbitrary extensionssMakefile and Batchfile creations --makefileR3screate makefiles --no-makefilet store_falsesdo not create makefiles --batchfileR4screate batchfiles--no-batchfilesdo not create batchfiles-ms--use-make-modeR¬s#use make-mode for Makefile/make.bats-Ms--no-use-make-modes*do not use make-mode for Makefile/make.batsProject templatings-ts --templatedirt TEMPLATEDIRRqs%template directory for template filess-ds NAME=VALUEt variablessdefine a template variable( targparsetArgumentParserRt add_argumentRaR tadd_argument_groupRÊR…R`(tparsertgrouptext((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pyt get_parsers‚                          ic C@sætjjtjdƒtjjtjjtdƒdƒt ƒsKt ƒnt ƒ}y|j |ƒ}Wnt k r€}|jSXt|ƒ}td„|jƒDƒƒ}yíd|krêtddgƒj|ƒsêttdƒƒd Sntdddgƒj|ƒr‹|jd dƒ|jd |d ƒtjƒ}|j|ƒ|}t|ƒs•tƒtttd ƒƒƒttd ƒƒd Sn t|ƒWn)ttfk rÁtƒtdƒdSXx<|jƒD].\}}t|t ƒrÏt!|ƒ||wsR¢R|R}sH"quiet" is specified, but any of "project" or "author" is not specified.iR~RsHError: specified path is not a directory, or sphinx files already exist.sWsphinx-quickstart only generate into a empty directory. Please specify a new root path.s[Interrupted.]i‚Rt,RæR–sInvalid template variable: %sR©Rqi(*RðRït setlocaletLC_ALLt init_consoleR»RRIRRRRît parse_argst SystemExittcodetvarstdictR†RˆR‰R;RRµtDEFAULTStcopytupdateRÎRRŽtKeyboardInterrupttEOFErrorRXR R^RŠtextendtsplitR¾t ValueErrorRÉRÊRq( targvRëtargsRjR‹td2RÁtvalueRítvariableRŒ((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pytmainfsb"           ! t__main__([RAt __future__RRRçRïR»treR9R³t collectionsRtioRRtreadlinetparse_and_bindR`RdRÊt ImportErrortdocutils.utilsRtsixRRR R t six.movesR tsix.moves.urllib.parseR R±t sphinx.localeRðR RRt sphinx.utilRtsphinx.util.consoleRRRRRRtsphinx.util.osutilRRtsphinx.util.templateRttypingRRRRRRtgetattrtstdinRaRYR…RýRbR:ReR=t ExceptionR>RFRGRHRLRRR0RTR^RktcompileRoRpRŽRÉRÎRîRR R?R„(((s4lib/python2.7/site-packages/sphinx/cmd/quickstart.pyt s              " .1           )  p  RG