File: //lib/python3/dist-packages/sphinx/cmd/__pycache__/quickstart.cpython-310.pyc
o
�$�a�] �
@ sT d Z ddlZddlZddlZddlZddlZddlmZ ddlmZ ddl m
Z
m Z m Z m
Z
mZ z ddlZej rEdej v rEe�d� dZne�d � d
ZW n
eyZ dZd
ZY nw dd lmZ ddlZdd lmZmZ dd
lmZ ddlmZm Z m Z m Z m Z ddl m!Z! ddl"m#Z# eded�fded�fded�fded�fded�fded �fd ed �fd ed �fd!ed"�fd#ed$�fg
�Z$d%d
d&dd'd(ddd)�Z%d*Z&ej'd+kr�d,Z(nd-Z(d.e)d/e)fd0d1�Z*G d2d3� d3e+�Z,d4e)d/e)fd5d6�Z-d4e)d/e)fd7d8�Z.d4e)d/e)fd9d:�Z/d4e)d/e)fd;d<�Z0d=e)d/e e)ge)f fd>d?�Z1d4e)d/e2fd@dA�Z3d4e)d/e)fdBdC�Z4d4e)d/e)fdDdE�Z5de0fdFe)dGe)dHe e)ge
f d/ee)e2f fdIdJ�Z6G dKdL� dLe#�Z7dMe d/dfdNdO�Z8d^dMe dPe2dQe2dRe)d/df
dSdT�Z9dMe d/e2fdUdV�Z:d/ej;fdWdX�Z<ej=dYd� fdZe
e) d/e>fd[d\�Z?e@d]k�r�e�Ae?ej=dYd� �� dS dS )_z�
sphinx.cmd.quickstart
~~~~~~~~~~~~~~~~~~~~~
Quickly setup documentation source to work with Sphinx.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)� OrderedDict)�path)�Any�Callable�Dict�List�Union�libeditzbind ^I rl_completeTz
tab: completeF)� column_width)�__display_version__� package_dir)�__)�bold�color_terminal�colorize�nocolor�red)� ensuredir)�SphinxRenderer�autodocz,automatically insert docstrings from modules�doctestz2automatically test code snippets in doctest blocks� intersphinxz7link between Sphinx documentation of different projects�todoz9write "todo" entries that can be shown or hidden on build�coveragez!checks for documentation coverage�imgmathz+include math, rendered as PNG or SVG images�mathjaxz0include math, rendered in the browser by MathJax�ifconfigz7conditional inclusion of content based on config values�viewcodez=include links to the source code of documented Python objects� githubpagesz=create .nojekyll file to publish the document on GitHub pages�.�_�.rst�index)r �sep�dot�language�suffix�master�makefile� batchfilez> �win32r �purple�prompt�returnc C s& t jdkrt| dd� td�S t| �S )Nr* � ��end)�sys�platform�print�input)r, � r5 �7/usr/lib/python3/dist-packages/sphinx/cmd/quickstart.py�
term_inputL s
r7 c @ s e Zd ZdZdS )�ValidationErrorz Raised for validation errors.N)�__name__�
__module__� __qualname__�__doc__r5 r5 r5 r6 r8 W s r8 �xc C s$ t �| �} t �| �sttd���| S )Nz Please enter a valid path name.)r �
expanduser�isdirr8 r
�r= r5 r5 r6 �is_path[ s
rA c C s | dkr| S t | �S �Nr. )rA r@ r5 r5 r6 �is_path_or_emptyb s rC c C � | S �Nr5 r@ r5 r5 r6 � allow_emptyh � rF c C s | st td���| S )NzPlease enter some text.)r8 r
r@ r5 r5 r6 �nonemptyl s rH �lc s dt dt f� fdd� }|S )Nr= r- c s" | � vrt td�d�� � ��| S )NzPlease enter one of %s.�, )r8 r
�joinr@ �rI r5 r6 �vals s zchoice.<locals>.val)�str)rI rM r5 rL r6 �choicer s rO c C s$ | � � dvr ttd���| � � dv S )N)�Y�YES�N�NOz Please enter either 'y' or 'n'.)rP rQ )�upperr8 r
r@ r5 r5 r6 �booleanz s rU c C s, | dd� dkrt | �dksttd���| S )Nr � r z2Please enter a file suffix, e.g. '.rst' or '.txt'.)�lenr8 r
r@ r5 r5 r6 r& � s r& c C rD rE r5 r@ r5 r5 r6 �ok� rG rX �text�default� validatorc
C s� |d urt d| |f }nt | d }trntr!tt|dd�}ntt|dd�}t|��� }|r4|s4|}z||�}W |S tyX } ztt dt
|� �� W Y d }~q d }~ww )NTz %s [%s]: z: )�
input_modeFz* ) �
PROMPT_PREFIX� USE_LIBEDIT�readliner �COLOR_QUESTIONr7 �stripr8 r3 r rN )rY rZ r[ r, r= �errr5 r5 r6 � do_prompt� s*
� ��rc c sR e Zd Zdeddf� fdd� Zdedefdd�Zded edef� fd
d � Z� Z S ) �QuickstartRenderer� templatedirr- Nc s |pd| _ t� �� d S rB )re �super�__init__)�selfre �� __class__r5 r6 rg � s
zQuickstartRenderer.__init__�
template_namec C s, t �| jt �|��}| jrt �|�rdS dS )z�Check if custom template file exists.
Note: Please don't use this function from extensions.
It will be removed in the future without deprecation period.
TF)r rK re �basename�exists)rh rk �templater5 r5 r6 �_has_custom_template� s z'QuickstartRenderer._has_custom_template�contextc s8 | � |�rt�| jt�|��}| �||�S t� �||�S rE )ro r rK re rl �render_from_filerf �render)rh rk rp �custom_templateri r5 r6 rr � s
zQuickstartRenderer.render)
r9 r: r; rN rg �boolro r rr �
__classcell__r5 r5 ri r6 rd � s " rd �dc C sp t ttd��t � t � t td�� d| v r't � t ttd��| d � nt � t td�� ttd�dt�| d< t�t�| d d��sQt�t�| d d d��r�t � t ttd
��� t td �� t � ttd �d
t �| d< | d sxt
� d� t�t�| d d��sQt�t�| d d d��sQd| vr�t � t td�� ttd�dt �| d< d| vr�t � t td�� ttd�dt
�| d< d| vr�t � t td�� ttd��| d< d| vr�ttd��| d< d | vr�t � t td �� ttd �d
t�| d < d | v�rttd �| d t�| d < d!| v�r(t � t td"�� ttd#�d$�| d!< | d! d$k�r(d%| d!< d&| v�r@t � t td'�� ttd(�d)t�| d&< d*| v�rWt � t td+�� ttd,�d-�| d*< t�t�| d | d* | d& ���s|t�t�| d d | d* | d& ���r�t � t ttd.�| d* | d& �� t td/�� t � ttd0�| d* �| d*< t�t�| d | d* | d& ���s|t�t�| d d | d* | d& ���s|d1| v�r t td2�� g | d1< t�� D ]\}}td3||f dt ��r�| d1 �d4| � �q�d5d6h�| d1 ��r t td7�� | d1 �d5� d8| v�r$t � t td9�� ttd:�d;t �| d8< d<| v�r3ttd=�d;t �| d<< t � d%S )>a4 Ask 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.zyPlease enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).r zSelected root path: %sz&Enter the root path for documentation.z Root path for the documentationr �conf.py�sourcezDError: 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. rV r# 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 dirr �projectzIThe project name will occur in several places in the built documentation.z Project name�authorzAuthor 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 version�releasezProject releaser% a3 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
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language.zProject language�enNr& 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 suffixr! r' 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)r" zKError: 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)�
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))r3 r r
r rc rA r �isfilerK rC r1 �exitrU rX rF r& �
EXTENSIONS�items�append�issubset�remove)rv �name� descriptionr5 r5 r6 �ask_user� s� � �
��
$"�
� �$�"�
�
r� � overwrite�silentre c s� t |d�}d� vr
d� d< d� vrd� d< � d � d< t�� � d< t� d �d
� d < � �d g � t�d
�d � d � d< tj�� d �� d< t � d � � d rZt�
� d d�n� d }t |� � d rst�
� d d�}d� d< n t�
|� d d �}t t � d d ddg�}d�
|�� d< t |� t t�
|� d d �� t t�
|� d d �� d?d t
d t
d t
d df� �fd d!�
}|r�tj�
|d"�nd} | r�t�| �s�tj�
tdd#d"�} t| �� }
|
�� } W d � n1 s�w Y |t�
|d$�|�| � �� t�
|� d � d% �} |�d&��r"d'}
ttd(|
�� || |�d&� �� n || |�d)� �� � �d*�d+u �r8d,}d-}nd.}d/}� d0 d+u �rm� d �rJdnd1� d2< � d �rUdn� d d � d3< |t�
� d d4�|�|� �d5� � d6 d+u �r�� d �r{dnd1� d2< � d �r�dn� d d � d3< |t�
� d d7�|�|� �d8� |�r�dS t� tttd9��� t� ttd:�| dd;� � d0 �sň d6 �r�ttd<�� n
ttd=�||f � ttd>�� t� dS )@z(Generate project based on values in *d*.)re �
mastertoctreer. �mastertocmaxdepth� r' �root_doc�nowrz �=�project_underliner z%YrJ r{ � copyrightr r# rx �build�exclude_patternsr$ z Thumbs.dbz .DS_Store� templates�staticN�fpath�content�newliner- c s� �st �| �s3d� vrttd�| � t| dd|d��}|�|� W d � d S 1 s,w Y d S d� vrAttd�| � d S d S )N�quietzCreating file %s.�wtzutf-8)�encodingr� z!File %s already exists, skipping.)r r� r3 r
�open�write)r� r� r� �f�rv r� r5 r6 �
write_filem s "��z generate.<locals>.write_filez conf.py_t�
quickstartrw r& zquickstart/master_doc.rst_tz{A custom template `master_doc.rst_t` found. It has been renamed to `root_doc.rst_t`. Please rename it on your project too.r zquickstart/root_doc.rst_t� make_modeTzquickstart/Makefile.new_tzquickstart/make.bat.new_tzquickstart/Makefile_tzquickstart/make.bat_tr( r �rsrcdir� rbuilddir�Makefile�
r) �make.batz
z:Finished: An initial directory structure has been created.zYYou should now populate your master file %s and create other documentation
source files. r/ z<Use the Makefile to build the docs, like so:
make builderzYUse the sphinx-build command to build the docs, like so:
sphinx-build -b builder %s %szPwhere "builder" is one of the supported builders, e.g. html, latex or linkcheck.rE )rd �time�asctimer
�
setdefault�strftime�osr �abspathr rK �map�reprrN r� r r� �read�
render_stringro r3 r rr �getr r
)rv r� r� re rn �srcdir�builddirr� r� � conf_pathr� � conf_text�
masterfile�msg�makefile_template�batchfile_templater5 r� r6 �generateI s�
�"
� � ����
r� c C s� | d }t �|�s dS t �|�sdS ddhtt�|��@ r dS | d r8tj �d|�}t �|�s1dS t �|�s8dS d| d d
| d d | d | d
g}t|�tt�|��@ rYdS dS )Nr TFr� r� r# rx rw r$ r� r� r' r& )r rm r? �setr� �listdirrK )rv �dir�reserved_namesr5 r5 r6 � valid_dir� s*
�r� c C s� t d�} tjdt d�| d�}|jddddd t d �d
� |jd d d
dt d� |jddddt d�d� |�t d��}|jdddd t d�d
� |jdddt d �d � |jd d d t d!�d"� |�t d#��}|jd$d%d&d't d(�d)� |jd*d+d,d-t d.�d)� |jd/d0d d1t d2�d3� |jd4d5d6d7t d8�d)� |jd9d:d;d<t d=�d)� |jd>d?d@t dA�d"� |jdBdCdDt dE�d"� |jdFddGt dH�dI� |�t dJ��}tD ]}|jdK| dLdM| dNt dO�| dP� q�|jdQdRdNdSt dT�dU� |�t dV��}|jdWddXdYt dZ�d
� |jd[ddXt d\�d � |jd]dd^dYt d_�d
� |jd`dd^t da�d � |jdbdcddddYt de�d
� |jdfdgdddt dh�d � |�t di��}|jdjdkdldmt dn�d)� |jdodpdSdqt dr�ds� |S )tNz�
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.
z %(prog)s [OPTIONS] <PROJECT_DIR>z:For more information, visit <https://www.sphinx-doc.org/>.)�usage�epilogr� z-qz--quiet�
store_truer� z
quiet mode)�action�destrZ �helpz --versionr| � show_versionz %%(prog)s %s)r� r� r| r � PROJECT_DIRr �?z project root)�metavarrZ �nargsr� zStructure optionsz--sepr# z,if specified, separate source and build dirsz--no-sep� store_falsez/if specified, create build dir under source dir)r� r� r� z--dot�DOTr z&replacement for dot in _templates etc.)r� rZ r� zProject basic optionsz-pz --project�PROJECTrz z project name)r� r� r� z-az--author�AUTHORr{ z author namesz-v�VERSIONr. zversion of project)r� r� rZ r� z-rz --release�RELEASEr} zrelease of projectz-lz
--language�LANGUAGEr% zdocument languagez--suffix�SUFFIXr! zsource file suffixz--master�MASTERr" zmaster document namez--epubFzuse epub)r� rZ r� zExtension optionsz--ext-%s� append_constr� r zenable %s extension)r� �constr� r� z --extensionsr� r� zenable arbitrary extensions)r� r� r� r� z Makefile and Batchfile creationz
--makefiler( Tzcreate makefilez
--no-makefilezdo not create makefilez --batchfiler) zcreate batchfilez--no-batchfilezdo not create batchfilez-mz--use-make-moder� z#use make-mode for Makefile/make.batz-Mz--no-use-make-modez*do not use make-mode for Makefile/make.batzProject templatingz-tz
--templatedir� TEMPLATEDIRre z%template directory for template filesz-dz
NAME=VALUE� variableszdefine a template variable)r� r� r� r� )r
�argparse�ArgumentParser� add_argumentr �add_argument_groupr� )r� �parser�group�extr5 r5 r6 �
get_parser� s� �� �
� � �
�
� � � � � �
�
�
�
�
� �
� ��
�
�
�
�r� rV �argvc
C s
t j�tjd� t j�tj�td�d� t � st
� t � }z|� | �}W n t
y9 } z |jW Y d }~S d }~ww t|�}dd� |�� D �}|�dg � |d d d � D ]}d|v rl|d �|� |d �|�d�� qUzSd|v r�d d
h�|�s�ttd �� W d S h d
��|�r�|�dd� |�d|d � t�� }|�|� |}t|�s�t� tt td��� ttd�� W d S nt |� W n t t fy� t� td� Y dS w |� dg �D ] }z
|�d�\}} | ||< W q� t!y� ttd�| � Y q�w t"|d|j#d� dS )Nr. �locale�sphinxc S s i | ] \}}|d ur||�qS rE r5 )�.0�k�vr5 r5 r6 �
<dictcomp>0 s zmain.<locals>.<dictcomp>r �,r� rz r{ zH"quiet" is specified, but any of "project" or "author" is not specified.rV > r� r{ rz r| r} zHError: 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.]� r� r� z Invalid template variable: %sF)r� re r )$r� r� � setlocale�LC_ALL� init_consoler� r rK r r r r� �
parse_args�
SystemExit�code�varsr� r� r� �extend�splitr� r3 r
�DEFAULTS�copy�updater� r r� �KeyboardInterrupt�EOFErrorr� �
ValueErrorr� re )
r� r� �argsrb rv r� �d2�variabler� �valuer5 r5 r6 �main sh �� �
��� �r �__main__)TFN)Br< r� r� r� r1 r� � collectionsr r �typingr r r r r r_ �parse_and_bindr^ � ImportError�docutils.utilsr
�
sphinx.localer� r r r
�sphinx.util.consoler r r r r �sphinx.util.osutilr �sphinx.util.templater r� r� r] r2 r` rN r7 � Exceptionr8 rA rC rF rH rO rt rU r& rX rc rd r� r� r� r� r� r� �intr r9 r� r5 r5 r5 r6 �<module> s�
� �
��
2
�e $U
A �