| Server IP : 127.0.0.1 / Your IP : 216.73.216.109 Web Server : Apache/2.4.54 (Win64) OpenSSL/1.1.1q PHP/8.1.10 System : Windows NT DESKTOP-E5T4RUN 10.0 build 19045 (Windows 10) AMD64 User : SERVERWEB ( 0) PHP Version : 8.1.10 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : OFF | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : C:/cygwin64/lib/python3.9/site-packages/sphinx/cmd/__pycache__/ |
Upload File : |
a
�ab�] �
@ s, d Z ddlZddlZddlZddlZddlZddlmZ ddlmZ ddl m
Z
m Z m Z m
Z
mZ z:ddlZej r�dej v r�e�d� dZne�d � d
ZW n ey� dZd
ZY n0 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+k�r�d,Z(nd-Z(e)e)d.�d/d0�Z*G d1d2� d2e+�Z,e)e)d3�d4d5�Z-e)e)d3�d6d7�Z.e)e)d3�d8d9�Z/e)e)d3�d:d;�Z0e)e e)ge)f d<�d=d>�Z1e)e2d3�d?d@�Z3e)e)d3�dAdB�Z4e)e)d3�dCdD�Z5de0fe)e)e e)ge
f ee)e2f dE�dFdG�Z6G dHdI� dIe#�Z7e ddJ�dKdL�Z8dZe e2e2e)ddM�dNdO�Z9e e2dJ�dPdQ�Z:ej;dR�dSdT�Z<ej=dUd� fe
e) e>dV�dWdX�Z?e@dYk�r(e�Ae?ej=dUd� �� dS )[z�
sphinx.cmd.quickstart
~~~~~~~~~~~~~~~~~~~~~
Quickly setup documentation source to work with Sphinx.
:copyright: Copyright 2007-2022 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)�SphinxRendererZautodocz,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�.�_�.rst�index)r �sep�dot�language�suffix�master�makefile� batchfilez> �win32r Zpurple)�prompt�returnc C s* t jdkr t| dd� td�S t| �S d S )Nr � ��end)�sys�platform�print�input)r! � r* �9/usr/lib/python3.9/site-packages/sphinx/cmd/quickstart.py�
term_inputL s
r, c @ s e Zd ZdZdS )�ValidationErrorz Raised for validation errors.N)�__name__�
__module__� __qualname__�__doc__r* r* r* r+ r- W s r- ��xr" c C s$ t �| �} t �| �s ttd���| S )Nz Please enter a valid path name.)r �
expanduser�isdirr- r
�r3 r* r* r+ �is_path[ s
r7 c C s | dkr | S t | �S �Nr# )r7 r6 r* r* r+ �is_path_or_emptyb s r9 c C s | S �Nr* r6 r* r* r+ � allow_emptyh s r; c C s | st td���| S )NzPlease enter some text.)r- r
r6 r* r* r+ �nonemptyl s r< )�lr" c s t t d�� fdd� }|S )Nr2 c s" | � vr t td�d�� � ��| S )NzPlease enter one of %s.�, )r- r
�joinr6 �r= r* r+ �vals s zchoice.<locals>.val)�str)r= rA r* r@ r+ �choicer s rC c C s$ | � � dvrttd���| � � dv S )N)�Y�YES�NZNOz Please enter either 'y' or 'n'.)rD rE )�upperr- r
r6 r* r* r+ �booleanz s rH c C s, | dd� dkr t | �dks(ttd���| S )Nr � r z2Please enter a file suffix, e.g. '.rst' or '.txt'.)�lenr- r
r6 r* r* r+ r � s r c C s | S r: r* r6 r* r* r+ �ok� s rK )�text�default� validatorr" c
C s� |d urt d| |f }n t | d }tr,n"tr@tt|dd�}ntt|dd�}t|��� }|rf|sf|}z ||�}W q� ty� } z,tt dt
|� �� W Y d }~q W Y d }~q�d }~0 0 q�q |S )Nz %s [%s]: z: T)Z
input_modeFz* ) �
PROMPT_PREFIX� USE_LIBEDIT�readliner �COLOR_QUESTIONr, �stripr- r( r rB )rL rM rN r! r3 �errr* r* r+ � do_prompt� s$ "rU c sJ e Zd Zedd�� fdd� Zeed�dd�Zeeed�� fd d
� Z� Z S ) �QuickstartRendererN)� templatedirr" c s |pd| _ t� �� d S r8 )rW �super�__init__)�selfrW �� __class__r* r+ rY � s
zQuickstartRenderer.__init__)�
template_namer" c C s0 t �| jt �|��}| jr(t �|�r(dS dS 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.
TFN)r r? rW �basename�exists)rZ r] �templater* r* r+ �_has_custom_template� s z'QuickstartRenderer._has_custom_template)r] �contextr" c s< | � |�r*t�| jt�|��}| �||�S t� �||�S d S r: )ra r r? rW r^ Zrender_from_filerX �render)rZ r] rb Zcustom_templater[ r* r+ rc � s
zQuickstartRenderer.render)
r. r/ r0 rB rY �boolra r rc �
__classcell__r* r* r[ r+ rV � s rV )�dr" c C s t ttd��t � t � t td�� d| v rNt � t ttd��| d � n&t � t td�� ttd�dt�| d< t�t�| d d��s�t�t�| d d d��r�t � t ttd
��� t td �� t � ttd �d
t �| d< | d stt
� d� qtd| v�r"t � t td�� ttd�dt �| d< d| v�rRt � t td�� ttd�dt
�| d< d| v�r~t � t td�� ttd��| d< d| v�r�ttd��| d< d | v�r�t � t td �� ttd �d
t�| d < d | v�r�ttd �| 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�r�t � 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*< �q�d1| v�r�t td2�� g | d1< t�� D ]2\}}td3||f dt ��rN| d1 �d4| � �qNd5d6h�| d1 ��r�t td7�� | d1 �d5� d8| v�r�t � t td9�� ttd:�d;t �| d8< d<| v�r�ttd=�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# rI 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))r( r r
r rU r7 r �isfiler? r9 r& �exitrH rK r; r �
EXTENSIONS�items�append�issubset�remove)rf �name� descriptionr* r* r+ �ask_user� s� � �
$"�
� �
r{ )rf � overwrite�silentrW r" c s� t |d�}d� vrd� d< d� vr*d� d< � d � d< t�� � d< t� d �d
� d < � �d g � t�d
�d � d � d< tj�� d �� d< t � d � � d r�t�
� d d�n� d }t |� � d r�t�
� 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<t
t
t
dd �� �fd d �
}|�r�tj�
|d �nd} | �r�t�| ��s�tj�
tdd d �} t| ��}
|
�� } W d � n1 �s�0 Y |t�
|d!�|�| � �� t�
|� d � d" �} |�d#��rFd$}
ttd%|
�� || |�d#� �� n|| |�d&� �� � �d'�d(u �rrd)}d*}nd+}d,}� d- d(u �r܈ d �r�dnd.� d/< � d �r�dn
� d d � d0< |t�
� d d1�|�|� �d2� � d3 d(u �r>� d �r�dnd.� d/< � d �rdn
� d d � d0< |t�
� d d4�|�|� �d5� |�rHdS t� tttd6��� t� ttd7�| dd8� � d- �s�� d3 �r�ttd9�� nttd:�||f � ttd;�� t� dS )=z(Generate project based on values in *d*.)rW Z
mastertoctreer# Zmastertocmaxdepth� r Zroot_docZnowrj �=Zproject_underlinero z%Yr> rk � copyrightr r rh Zbuild�exclude_patternsr z Thumbs.dbz .DS_Store� templates�staticN)�fpath�content�newliner" c s~ �st �| �sbd� vr&ttd�| � t| dd|d��}|�|� W d � qz1 sV0 Y nd� vrzttd�| � d S )N�quietzCreating file %s.Zwtzutf-8)�encodingr� z!File %s already exists, skipping.)r rr r( r
�open�write)r� r� r� �f�rf r| r* r+ �
write_filem s *z generate.<locals>.write_filez conf.py_tZ
quickstartrg 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 ZrsrcdirZ 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.)N)rV �time�asctimer
�
setdefault�strftime�osr �abspathr r? �map�reprrB rr r r� �readZ
render_stringra r( r rc �getr r
)rf r| r} rW r` ZsrcdirZbuilddirr� r� Z conf_pathr� Z conf_textZ
masterfile�msgZmakefile_templateZbatchfile_templater* r� r+ �generateI s�
�
( � ���� r� c C s� | d }t �|�sdS t �|�s$dS ddhtt�|��@ r>dS | d rptj �d|�}t �|�sbdS t �|�spdS d| d d
| d d | d | d
g}t|�tt�|��@ r�dS dS )Nr TFr� r� r rh rg r r� r� r r )r r_ r5 �setr� �listdirr? )rf �dir�reserved_namesr* r* r+ � valid_dir� s*
�r� )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�epilogrz z-qz--quiet�
store_truer� z
quiet mode)�action�destrM �helpz --versionrl Z show_versionz %%(prog)s %s)r� r� rl r Z PROJECT_DIRr �?z project root)�metavarrM �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� rM r� zProject basic optionsz-pz --projectZPROJECTrj z project name)r� r� r� z-az--authorZAUTHORrk z author namesz-vZVERSIONr# zversion of project)r� r� rM r� z-rz --releaseZRELEASErm zrelease of projectz-lz
--language�LANGUAGEr zdocument languagez--suffixZSUFFIXr zsource file suffixz--masterZMASTERr zmaster document namez--epubFzuse epub)r� rM r� zExtension optionsz--ext-%s� append_constrp ro zenable %s extension)r� �constr� r� z --extensionsrt rv 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
--templatedirZ TEMPLATEDIRrW z%template directory for template filesz-dz
NAME=VALUE� variableszdefine a template variable)r� r� r� r� )r
�argparse�ArgumentParser� add_argumentr �add_argument_grouprt )rz �parser�group�extr* r* r+ �
get_parser� s� �� �
� � �
�
� � � � � �
�
�
�
�
� �
� ��
�
�
�
�r� rI )�argvr" c
C s t j�tjd� t j�tj�td�d� t � s4t
� t � }z|� | �}W n* t
yr } z|jW Y d }~S d }~0 0 t|�}dd� |�� D �}|�dg � |d d d � D ].}d|v r�|d �|� |d �|�d�� q�z�d|v �rd d
h�|��sttd �� W d S h d
��|��r~|�dd� |�d|d � t�� }|�|� |}t|��s�t� tt td��� ttd�� W d S nt |� W n( t t f�y� t� td� Y dS 0 |� dg �D ]F}z|�d�\}} | ||< W n$ t!�y ttd�| � Y n0 �q�t"|d|j#d� dS )Nr# �locale�sphinxc S s i | ]\}}|d ur||�qS r: r* )�.0�k�vr* r* r+ �
<dictcomp>0 � zmain.<locals>.<dictcomp>ro �,r� rj rk zH"quiet" is specified, but any of "project" or "author" is not specified.rI > rj rk r� rl rm 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| rW r )$r� r� � setlocale�LC_ALLZ init_consoler� r r? r r r r� �
parse_args�
SystemExit�code�varsru r� rx �extend�splitrw r( r
�DEFAULTS�copy�updater� r r{ �KeyboardInterrupt�EOFErrorr� �
ValueErrorr� rW )
r� r� �argsrT rf r� Zd2�variablery �valuer* r* r+ �main sZ
r� �__main__)TFN)Br1 r� r� r� r& r� � collectionsr r �typingr r r r r rQ �parse_and_bindrP � ImportErrorZdocutils.utilsr
Z
sphinx.localer� r r r
Zsphinx.util.consoler r r r r Zsphinx.util.osutilr Zsphinx.util.templater rt r� rO r' rR rB r, � Exceptionr- r7 r9 r; r< rC rd rH r rK rU rV r{ r� r� r� r� r� �intr� r. rs r* r* r* r+ �<module> s�
�� ,
� e U"A