B \c @sdZddlmZddlmZddlZddlZddlZddlZddlZddl Z ddl m Z ddl m Z ddlmZy:ddlZejrdejkred d Zned d ZWnek rd ZYnXdd lmZddlmZmZmZmZddlmZddlmZddlZ ddl m!Z!m"Z"ddlm#Z#ddl$m%Z%ddl&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z,ddl-m.Z.m/Z/ddl0m1Z1e2ej3ddZ4e de#dfde#dfde#dfde#dfd e#d!fd"e#d#fd$e#d%fd&e#d'fd(e#d)fd*e#d+fg Z5d,d d-dd.d/d d d0Z6d1Z7ej8d2krd3Z9nd4Z9d5d6Z:Gd7d8d8e;Zd=d>Z?d?d@Z@dAdBZAdCdDZBdEdFZCdGdHZDde?fdIdJZEeFdKfdLdMZGGdNdOdOe1ZHdPdQZId\dRdSZJdTdUZKdVdWZLejMdXdfdYdZZNeOd[krePeNejMdXddS)]z 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. )absolute_import)print_functionN) OrderedDict)open)pathlibeditzbind ^I rl_completeTz tab: completeF) column_width)PY2PY3 text_type binary_type)input)quote)__display_version__ package_dir)__) texescape)colorizeboldred turquoisenocolorcolor_terminal) ensuredir make_filename)SphinxRendererencodingZautodocz,automatically insert docstrings from modulesZdoctestz2automatically test code snippets in doctest blocksZ intersphinxz7link between Sphinx documentation of different projectsZtodoz9write "todo" entries that can be shown or hidden on buildZcoveragez!checks for documentation coverageZimgmathz+include math, rendered as PNG or SVG imagesZmathjaxz0include math, rendered in the browser by MathJaxZifconfigz7conditional inclusion of content based on config valuesZviewcodez=include links to the source code of documented Python objectsZ githubpagesz=create .nojekyll file to publish the document on GitHub pages._z.rstindex)rsepdotlanguagesuffixmastermakefile batchfilez> win32rZpurplecCs*tjdkrt|ddtdSt|SdS)Nr')end)sysplatformprintr )promptr.4lib/python3.7/site-packages/sphinx/cmd/quickstart.py term_input]s  r0c@seZdZdZdS)ValidationErrorzRaised for validation errors.N)__name__ __module__ __qualname____doc__r.r.r.r/r1isr1cCs.t|}t|r*t|s*ttd|S)NzPlease enter a valid path name.)r expanduserexistsisdirr1r)xr.r.r/is_pathms  r:cCs|S)Nr.)r9r.r.r/ allow_emptyusr;cCs|sttd|S)NzPlease enter some text.)r1r)r9r.r.r/nonemptyzs r<csfdd}|S)Ncs"|krttdd|S)NzPlease enter one of %s.z, )r1rjoin)r9)lr.r/valszchoice..valr.)r>r?r.)r>r/choices r@cCs$|dkrttd|dkS)N)YYESNZNOzPlease enter either 'y' or 'n'.)rArB)upperr1r)r9r.r.r/booleans  rEcCs,|dddkrt|dks(ttd|S)Nrrz2Please enter a file suffix, e.g. '.rst' or '.txt'.)lenr1r)r9r.r.r/r#s r#cCs|S)Nr.)r9r.r.r/oksrHcCsxt|tr|Str|tS|dddd|kr>|dStttdy |dStk rr|dSXdS)Nasciireplacez`* Note: non-ASCII characters entered and terminal encoding unknown -- assuming UTF-8 or Latin-1.zutf-8latin1) isinstancer TERM_ENCODINGdecodeencoder,rrUnicodeDecodeError)textr.r.r/ term_decodes    rRc Csx|dk rtd||f}n t|d}tr|dddd|krtrV|t}n>tttdy|d}Wntk r|d}YnXt rnt t |dd }t | }|r|s|}t|}y ||}Wn:tk r}zttd t|wWdd}~XYnXPqW|S) Nz %s [%s]: z: rIrJzd* Note: non-ASCII default value provided and terminal encoding unknown -- assuming UTF-8 or Latin-1.zutf-8rKT)Z input_modez* ) PROMPT_PREFIXr rOrNrMr,rrUnicodeEncodeError USE_LIBEDITrCOLOR_QUESTIONr0striprRr1rstr)rQdefaultZ validatorr-r9errr.r.r/ do_prompts8    r[z [uU]('.*?')cCstr|d|S|SdS)Nz\1)r sub)sourceZrexr.r.r/convert_python_sources r^cs(eZdZfddZfddZZS)QuickstartRenderercs|pd|_tt|dS)Nr() templatedirsuperr___init__)selfr`) __class__r.r/rbs zQuickstartRenderer.__init__csFt|jt|}|jr0t|r0|||Stt|||SdS)N) rr=r`basenamer7Zrender_from_filerar_render)rcZ template_namecontextZ user_template)rdr.r/rfs zQuickstartRenderer.render)r2r3r4rbrf __classcell__r.r.)rdr/r_s r_c Cstttdtttdd|krBtttd|dn ttdttddt|d<xtt|ddstt|dd drttttd ttd tttd d t|d<|dsdt dqdWd|krttdttddt |d<d|kr8ttdttddt |d<d|kr^ttdttd|d<d|krxttd|d<d|krttdttdd t |d<d|krttd |dt |d<d!|krttd"ttd#d$|d!<|d!d$krd%|d!<d&|kr,ttd'ttd(d)t|d&<d*|krTttd+ttd,d-|d*<xtt|d|d*|d&stt|dd |d*|d&rttttd.|d*|d&ttd/tttd0|d*|d*<qVWd1|krttd2g|d1<x>tD]2\}}td3||fdt r|d1d4|qWtd5d6g|d1rttd7|d1d5d8|krttd9ttd:d;t |d8<d<|krttd=d;t |d<<td%S)>a4Ask 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 z,Welcome to the Sphinx %s quickstart utility.zz Please enter values for the following settings (just press Enter to accept a default value, if one is given in brackets).rz Selected root path: %sz' Enter the root path for documentation.zRoot path for the documentationrzconf.pyr]zDError: an existing conf.py has been found in the selected root path.z>sphinx-quickstart will not overwrite existing Sphinx projects.z4Please enter a new root path (or just Enter to exit)r(rFr z 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.z+Separate source and build directories (y/n)nr!z 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.z(Name prefix for templates and static dirrprojectzJ The project name will occur in several places in the built documentation.z Project nameauthorzAuthor name(s)versiona/ 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.zProject versionreleasezProject releaser"a 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.zProject languageZenNr#z The file name suffix for source files. Commonly, this is either ".txt" or ".rst". Only files with this suffix are considered documents.zSource file suffixz.rstr$a 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.z-Name of your master document (without suffix)rzKError: the master file %s has already been found in the selected root path.z7sphinx-quickstart will not overwrite the existing file.zIPlease enter a new file name, or rename the existing file and press Enter extensionszDIndicate which of the following Sphinx extensions should be enabled:z %s: %s (y/n)z sphinx.ext.%szsphinx.ext.imgmathzsphinx.ext.mathjaxzZNote: imgmath and mathjax cannot be enabled at the same time. imgmath has been deselected.r%z 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.zCreate Makefile? (y/n)yr&z"Create Windows command file? (y/n))r,rrrr[r:risfiler=r*exitrErHr;r# EXTENSIONSitemsappendsetissubsetremove)dname descriptionr.r.r/ask_users             &&          r{c st|d}tdkr"dd<dkr2dd<td<tdd<tdd d <dd <t d <t dd d< dgt dddd<t dtjd<ddd<t ddtjd<x.dD]&}|dddd|d<qWtdsFtddrbtdd phd}t|drtdd!}dd"<n:t|d#d!}ttd#d!d$d%g}d|d"<t|tt|d#d&tt|d#d'dEfd)d* } |r,tj|d+nd(} | rBt| sTtjtd&d,d+} t| } t| } Wd(QRX| t|d-|| t|d.d/} | | |d0d1d2krd3}d4}nd5}d6}d7d2kr@drd pd8d9<drd!pd#d!d:<| tdd;||d<d=d2krdr^d p`d8d9<drvd!pd#d!d:<| tdd>||d?|rd(St t t!t"d@t t"dA| d7sd=rt"dBpt"dC||ft"dDd(S)Fz(Generate project based on values in *d*.)r`Z mastertoctreer(Zmastertocmaxdepthr rjZ project_fnZidnaZ project_urlZproject_manpageZnow=Zproject_underlinernz%Yz, rk copyrightauthor_texescapedz Documentation project_docproject_doc_texescaped) rjrrrkrr~rlrmr$\z\\'z\'_strrr r]Zbuildexclude_patternsr!z Thumbs.dbz .DS_Store templatesstaticNc sjst|sNdkr&ttd|t|dd|d}||WdQRXndkrfttd|dS)NquietzCreating file %s.Zwtzutf-8)rnewlinez!File %s already exists, skipping.)rrpr,rrwrite)ZfpathZcontentrf)rx overwriter.r/ write_fileszgenerate..write_filez conf.py_tZ quickstartzconf.pyr$r#zquickstart/master_doc.rst_t make_modeTzquickstart/Makefile.new_tzquickstart/make.bat.new_tzquickstart/Makefile_tzquickstart/make.bat_tr%rZrsrcdirZ rbuilddirMakefile r&zmake.batz z:Finished: An initial directory structure has been created.zZ You should now populate your master file %s and create other documentation source files. z=Use the Makefile to build the docs, like so: make builder zZUse the sphinx-build command to build the docs, like so: sphinx-build -b builder %s %s zQwhere "builder" is one of the supported builders, e.g. html, latex or linkcheck. )N)#r_rZinitr rurlquoterOlowertimeZasctimer setdefaultZstrftimer translateZtex_escape_maprJrr8rr=mapreprosrprrr^readZ render_stringrfgetr,rr)rxrZsilentr`templatekeyZsrcdirZbuilddirrrZ conf_pathrZ conf_textZ masterfileZmakefile_templateZbatchfile_templater.)rxrr/generates       & $        :rcCs|d}t|sdSt|s$dStddgtt|@rBdS|drttjd|}t|sfdSt|stdSd|d d |d d |d |d g}t|tt|@rdSdS)NrTFrzmake.batr r]zconf.pyr!rrr$r#)rr7r8rurlistdirr=)rxdirZreserved_namesr.r.r/ valid_dirs(      rcCstjdtdtdd}|jdddddtd d |jd d d dtd|jddddtdd|td}|jdddtdd|jddtdd|td}|jdd d!d"td#d$|jd%d&d'd(td)d$|jd*d+d d,td-d.|jd/d0d1d2td3d$|jd4d5d6d7td8d$|jd9d:td;d|jdd|jd?dd@tdAd|tdB}x2tD]*}|jdC|dDdE|dFtdG|dHqpW|jdIdJdFdKtdLdM|tdN}|jdOddPdtdQd |jdRdSdPtdTdU|jdVddWdtdXd |jdYdSdWtdZdU|jd[d\dd]d^td_d |jd`dadSd]tdbdU|tdc}|jdddedfdgtdhd$|jdidjdKdktdldm|S)nNz %(prog)s [OPTIONS] z5For more information, visit .z 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. )ZusageZepilogrzz-qz--quiet store_truerz quiet mode)actiondestrYhelpz --versionrlZ show_versionz %%(prog)s %s)rrrlrZ PROJECT_DIRr?z output path)metavarrYnargsrzStructure optionsz--sepz,if specified, separate source and build dirs)rrYrz--dotDOTz&replacement for dot in _templates etc.)rrzProject basic optionsz-pz --projectZPROJECTrjz project name)rrrz-az--authorZAUTHORrkz author namesz-vZVERSIONr(zversion of project)rrrYrz-rz --releaseZRELEASErmzrelease of projectz-lz --languageZLANGUAGEr"zdocument languagez--suffixZSUFFIXzsource file suffixz--masterZMASTERzmaster document namez--epubFzuse epubzExtension optionsz--ext-%sZ append_constz sphinx.ext.%srnzenable %s extension)rZconstrrz --extensionsrrrtzenable arbitrary extensions)rrrrzMakefile and Batchfile creationz --makefiler%zcreate makefilez --no-makefileZ store_falsezdo not create makefile)rrrz --batchfiler&zcreate batchfilez--no-batchfilezdo not create batchfilez-mz--use-make-moderTz#use make-mode for Makefile/make.batz-Mz--no-use-make-modez*do not use make-mode for Makefile/make.batzProject templatingz-tz --templatedirZ TEMPLATEDIRr`z%template directory for template filesz-dz NAME=VALUE variableszdefine a template variable)rrrr)argparseArgumentParserr add_argumentrZadd_argument_grouprr)parsergroupextr.r.r/ get_parsers                                          rrFc CsXtjtjdtjtjtddt s4t t }y| |}Wn$t k rl}z|jSd}~XYnXt|}tdd|D}yd|krtddg|sttd d Stdddg|r2|d d|d |d t}|||}t|s:ttttd ttdd Snt|Wn(ttfk rdttddSXx.|D]"\}}t|t rpt!|||<qpW|dgxF|dddD]2}d|kr|d"||d#|$dqWxX|%dgD]H} y| $d\} }||| <Wn&t&k r<ttd| YnXqWt'|d|j(ddS)Nr(localesphinxcss"|]\}}|dk r||fVqdS)Nr.).0kvr.r.r/ wszmain..rrjrkzH"quiet" is specified, but any of "project" or "author" is not specified.rFrlrmzHError: specified path is not a directory, or sphinx files already exist.zWsphinx-quickstart only generate into a empty directory. Please specify a new root path.z[Interrupted.]rn,rr}zInvalid template variable: %sF)rr`r))rr setlocaleLC_ALLZ init_consolerrr=rrrr parse_args SystemExitcodevarsdictrsrurvr,rrDEFAULTScopyupdaterrr{KeyboardInterruptEOFErrorrLr rRrwextendsplitr ValueErrorrr`) argvrargsrZrxZd2rvaluerZvariableryr.r.r/mainfsb         r__main__)TFN)Qr5Z __future__rrrrrrer*r collectionsriorrreadlineparse_and_bindrU ImportErrorZdocutils.utilsrZsixr r r r Z six.movesr Zsix.moves.urllib.parserrZ sphinx.localerrrrZ sphinx.utilrZsphinx.util.consolerrrrrrZsphinx.util.osutilrrZsphinx.util.templatergetattrstdinrMrrrrSr+rVr0 Exceptionr1r:r;r<r@rEr#rHrRr[compiler^r_r{rrrrrr2rqr.r.r.r/ s                          )  pRG