Dashboard
PHP:
8.2.30
OS:
Linux
User:
dh_nv8b2m
/
/
usr
/
lib
/
python3
/
dist-packages
/
sphinx
/
ext
/
__pycache__
📤 Upload
📝 New File
📁 New Folder
Close
Editing: apidoc.cpython-310.pyc
o �$�a�K � @ s d Z ddlZddlZddlZddlZddlZddlmZ ddlmZ ddlm Z ddlm Z ddl m Z m Z mZmZ ddlZddlmZmZ dd lmZ dd lmZ dd lmZmZ dd lmZ d ej v rnej d � d�Z ng d�Z de e � Z e �!edd�Z"de#de$fdd�Z%de#de#fdd�Z&dHde#dee# de$fd d �Z'd e#d e#d e ddfd!d"�Z( dId#e#d$e#d e d%e#ddf d&d'�Z)g dfd(e#d)e#d*e#d+ee# d e d,ee# d-e$d.ee# d%e#ddfd/d0�Z* 1 dJd1ee# d e d e#d%e#ddf d2d3�Z+g fde#d e d.ee# de$fd4d5�Z,de#d e d.ee# de$fd6d7�Z-d8e#d.ee# d e de ee#ee# ee# f ddf fd9d:�Z.d8e#d.ee# d e de$fd;d<�Z/ dId8e#d.ee# d e d%e#dee# f d=d>�Z0d(e#d.ee# de$fd?d@�Z1dej2fdAdB�Z3ej4dCd� fdDee# de5fdEdF�Z6e7dGk�r�e6� dS dS )Ku sphinx.ext.apidoc ~~~~~~~~~~~~~~~~~ Parses a directory tree looking for Python modules and packages and creates ReST files appropriately to create code documentation with Sphinx. It also creates a modules index (named modules.<suffix>). This is derived from the "sphinx-autopackage" script, which is: Copyright 2008 Société des arts technologiques (SAT), https://sat.qc.ca/ :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. � N)�copy��fnmatch)�EXTENSION_SUFFIXES)�path)�Any� Generator�List�Tuple)�__display_version__� package_dir)� EXTENSIONS)�__)�FileAvoidWrite� ensuredir)� ReSTRenderer�SPHINX_APIDOC_OPTIONS�,)�membersz undoc-memberszshow-inheritance)z.pyz.pyx� templates�apidoc�filename�returnc C s4 t �| �}tttdd�D ] }|d| kr dS q dS )z)Check *filename* is __init__ file or not.T)�key�reverse�__init__F)r �basename�sorted� PY_SUFFIXES�len)r r �suffix� r! �3/usr/lib/python3/dist-packages/sphinx/ext/apidoc.py� is_initpy3 s �r# �modnamesc G s d� td| ��S )z Join module names with dots.�.N)�join�filter)r$ r! r! r" � module_join= s r( �dirname�filesc C s8 |du r | du r dS |du rt �| �}tdd� |D ��S )z+Check given *files* contains __init__ file.NFc s � � | ] }t |�r|V qd S �N�r# ��.0�fr! r! r" � <genexpr>I � � z is_packagedir.<locals>.<genexpr>)�os�listdir�any)r) r* r! r! r" � is_packagedirB s r6 �name�text�optsc C s� t |dd�}t�|jd| |jf �}|jr!|s ttd�| � dS |js7t� |�r7|s5ttd�| � dS dS |sAttd�| � t |��}|� |� W d � dS 1 sVw Y dS )z0Write the output file for module/package <name>.�quietNz%s.%szWould create file %s.z!File %s already exists, skipping.zCreating file %s.) �getattrr r& �destdirr �dryrun�printr �force�isfiler �write)r7 r8 r9 r: �fnamer0 r! r! r" � write_fileL s � "�rC �packager �user_template_dirc C s` t t�}|jrd|vr|�d� t| |�}|j |||d�}t|tg��d|�}t |||� dS )�.Build the text of the file and write the file.�private-members)� show_headingsr �qualname�automodule_optionsz module.rst_tN) r �OPTIONS�includeprivate�appendr( � noheadingsr � template_dir�renderrC )rD r r9 rE �optionsrI �contextr8 r! r! r" �create_module_file_ s �rS �root�master_package�subroot�py_files�subs� is_namespace�excludesc s� � ����fdd�|D �} � ��fdd�|D �} ��fdd�| D �} t t�} �jr2d| vr2| �d� t���} | | | |�j�j| �j �jd� } t |t g�� d| �}t | |�� | ri�jrk| D ] }t d|�|� q_dS dS dS ) rF c s, g | ]}t t��|��� �st��|��qS r! )�is_skipped_packager r& r( )r/ �pkgname�rZ rU r9 rT rV r! r" � <listcomp>v s �z'create_package_file.<locals>.<listcomp>c s6 g | ]}t t��|��� �st|�s|�d �d �qS )r% r )�is_skipped_moduler r& r# �split�r/ �sub)rZ r9 rT r! r" r^ z s ��c s g | ]}t � �|��qS r! )r( )r/ �modname)rU rV r! r" r^ } s �rG ) r\ � subpackages� submodulesrY � modulefirst�separatemodulesrJ rH �maxdepthz package.rst_tN)r rK rL rM r( rf rg rN rh r rO rP rC rS )rT rU rV rW r9 rX rY rZ rE rd re rQ r\ rR r8 � submoduler! r] r" �create_package_fileq s8 � � � �rj �modulesc C sp | � � d}| dd� D ]}|�|d �r| �|� q |}q |j|j| d�}t|tg��d|�}t|||� dS )zCreate the module's index.� Nr% )�headerrh �docnamesz toc.rst_t) �sort� startswith�removerm rh r rO rP rC )rk r9 r7 rE � prev_module�modulerR r8 r! r! r" �create_modules_toc_file� s �rt c s` t �� �sdS t�t �� d��}tdd� |D ��}|s |js dS t� �fdd�|D ��r.dS dS )�%Check if we want to skip this module.Fz*.pyc s r+ r, r- r. r! r! r" r1 � r2 z%is_skipped_package.<locals>.<genexpr>Tc 3 s" � | ] }t t�� |���V qd S r, )� is_excludedr r& r. �r) rZ r! r" r1 � s � )r �isdir�globr& r5 �implicit_namespaces�all)r) r9 rZ r* �regular_packager! rw r" r[ � s r[ c C s, t �| �sdS t �| ��d�r|jsdS dS )ru T�_F)r �existsr rp rL )r r9 rZ r! r! r" r_ � s r_ �rootpathc # s� � t |dd�}t |dd�}tj| |d�D ]/\�}}t��fdd�|D ��}|r*d� nd� t� ��fd d�|D ��|d d �< �||fV qd S ) z@Walk through the directory and list files and subdirectories up.� followlinksFrL )r� c 3 s0 � | ]}|� t�rtt��|�� �s|V qd S r, )�endswithr rv r r& r. )rZ rT r! r" r1 � s � ��zwalk.<locals>.<genexpr>)r% )r% r} c 3 s0 � | ]}|� � �stt��|���s|V qd S r, )rp rv r r& ra ��exclude_prefixesrZ rT r! r" r1 � s � �N)r; r3 �walkr )r rZ r9 r� rL rX r* r! r� r" r� � s � "�r� c C s& t | ||�D ] \}}}|r dS qdS )zACheck the given directory contains child module/s (at least one).TF)r� )r rZ r9 rT rX r* r! r! r" �has_child_module� s �r� c C s� t |dd�}t| �s |r| �tj�d }nd}g }t| ||�D ]�\}}} td| �} | o-|} | rI| dd� D ]} t| �rG| �| � | �d| � q6n || krU|sU|dd�= q | sY| r�|sft | �dksft ||�s�|t | �d� � tj�� tjd�} | rt |||�r�t||| | ||| ||� |�t|| �� q || kr�|du s�J �| D ] }tt�| |�||�s�|�d�d }t||||� |�|� q�q |S )z` Look for every file in the directory tree and create the corresponding ReST files. rz F���Nr � r% )r; r6 r` r �sepr� r# rq �insertr r[ �lstrip�replacer� rj rM r( r_ r& rS )r rZ r9 rE rz � root_package� toplevelsrT rX r* �is_pkgrY r0 � subpackage�py_filers r! r! r" � recurse_tree� sP �� � �� ��r� c C s |D ] }t | |�r dS qdS )z�Check if the directory is in the exclude list. Note: by having trailing slashes, we avoid common prefix issues, like e.g. an exclude "foo" also accidentally excluding "foobar". TFr )rT rZ �excluder! r! r" rv # s �rv c C s� t jdtd�td�d�} | jddddt d � | jd td �d � | jd dtd�d� | jdddddtd�d� | jdddtd�d � | jd d dd td td!�d"� | jd#d$dd%td&�d � | jd'd(dd)d*td+�d,� | jd-d.dd/td0�d � | jd1d2dd3td4�d � | jd5d6dd7td8�d � | jd9dd:d;td<�d,� | jd=d>d?d:td@�d � | jdAdBddCtdD�d � | jdEdFddGtdH�d � | jdIddJtdK�d � | jdLdMddNdOtdP�d,� | jdQdRddStdT�d � | jdUdVddWtdX�d � | jdYdZdd[td\�d � | jd]d^dd_td`�d � | jdadbddtdc�d � | jdddeddftdg�d � | �tdh��}|jdidjdkdltdm�dn� tD ]}|jdo| dpdq| dktdr�| ds� �q2| �tdt��}|jdudvdwdxtdy�dz� | S ){NzH%(prog)s [OPTIONS] -o <OUTPUT_PATH> <MODULE_PATH> [EXCLUDE_PATTERN, ...]z:For more information, visit <https://www.sphinx-doc.org/>.aE Look recursively in <MODULE_PATH> for Python modules and packages and create one reST file with automodule directives per package in the <OUTPUT_PATH>. The <EXCLUDE_PATTERN>s can be file and/or directory patterns that will be excluded from generation. Note: By default this script will not overwrite already created files.)�usage�epilog� descriptionz --version�version� show_versionz %%(prog)s %s)�action�destr� � module_pathzpath to module to document)�help�exclude_pattern�*zGfnmatch-style file and/or directory patterns to exclude from generation)�nargsr� z-oz --output-dir�storer< Tz directory to place all output)r� r� �requiredr� z-q� store_truer: z,no output on stdout, just warnings on stderr)r� r� r� z-dz --maxdepthrh � z;maximum depth of submodules to show in the TOC (default: 4))r� r� �type�defaultr� z-fz--forcer? zoverwrite existing filesz-lz--follow-linksr� FzNfollow symbolic links. Powerful when combined with collective.recipe.omelette.)r� r� r� r� z-nz --dry-runr= z%run the script without creating filesz-ez --separaterg z1put documentation for each module on its own pagez-Pz --privaterL zinclude "_private" modulesz --tocfile�tocfilerk z0filename of table of contents (default: modules)z-Tz--no-toc� store_falsez%don't create a table of contents filez-Ez --no-headingsrN zedon't create headings for the module/package packages (e.g. when the docstrings already contain them)z-Mz--module-firstrf z7put module documentation before submodule documentationz--implicit-namespacesrz zNinterpret module paths according to PEP-0420 implicit namespaces specificationz-sz--suffixr �rstzfile suffix (default: rst)z-Fz--full�fullz.generate a full project with sphinx-quickstartz-az--append-syspath�append_syspathz9append module_path to sys.path, used when --full is givenz-Hz --doc-projectrm z(project name (default: root module name)z-Az --doc-author�authorz,project author(s), used when --full is givenz-Vz --doc-versionz*project version, used when --full is givenz-Rz --doc-release�releasezEproject release, used when --full is given, defaults to --doc-versionzextension optionsz --extensionsr � extensionsrM zenable arbitrary extensions)�metavarr� r� r� z--ext-%s� append_constz sphinx.ext.%szenable %s extension)r� �constr� r� zProject templatingz-tz --templatedir� TEMPLATEDIR� templatedirz%template directory for template files)r� r� r� )�argparse�ArgumentParserr � add_argumentr �int�add_argument_groupr )�parser�group�extr! r! r" � get_parser/ s� � ��� � � � � � � � � � � � �� � � � � � � � � � �r� r� �argvc C sh t j�tjd� t j�tj�td�d� t � }|� | �}t� |j �}|j du r0|�tj�d |_ |j�d�r>|jdd� |_t�|�sSttd�| tjd � t�d� |js[t|j� d d � |jD �}t ||||j �}|j �r%d d l m } |�!� d}d}|D ]} | �|d �r�q| }|d| 7 }qi d|j�dd�dd�d|j �d|j"p�d�d|j#p�d�d|j$p�|j#p�d�dd|j �dd�d d �d g d ��d d �d!d �d"d �d#|j%�d$|�d%d&�||j&d'��} |j'r�| d �(|j'� |j)r�d | d(< | d dd� D ]} d)| v �r| d �*| � | d �(| �d)�� q�|j�s#|j+| d |j,|j d*� d S |j-�r2t.|||j-|j � d S )+z+Parse and check the command line arguments.rl �locale�sphinxNr� r% r� z%s is not a directory.)�filec S s g | ]}t �|��qS r! )r �abspath)r/ r� r! r! r" r^ � s zmain.<locals>.<listcomp>r )� quickstartz %s r r� F�dotr} �projectr� �Authorr� r� r �master�index�epubTr� )zsphinx.ext.autodoczsphinx.ext.viewcodezsphinx.ext.todo�makefile� batchfile� make_mode�mastertocmaxdepth� mastertoctree�language�en)r� r� r: r )�silent� overwriter� )/r� r� � setlocale�LC_ALL� init_consoler3 r r& r r� � parse_argsr� r� rm r` r� r rp rx r> r �sys�stderr�exitr= r r< r� r� r� r� � sphinx.cmdr� ro r� r� r� rh r� r� �extendr: rq �generater? r� rt ) r� r� �argsr rZ rk �qsrr r8 rs �dr� r! r! r" �main� s� ���� � �� � � � � ������� � ��r� �__main__)NNr, )rk N)8�__doc__r� ry r� r3 r� r r �importlib.machineryr r �typingr r r r � sphinx.localer� r r �sphinx.cmd.quickstartr r �sphinx.util.osutilr r �sphinx.util.templater �environr` rK �tupler r& rO �str�boolr# r( r6 rC rS rj rt r[ r_ r� r� r� rv r� r� r� r� r� �__name__r! r! r! r" �<module> s� �� ������� �&�� �" � �� �6 $a L �
Save
Cancel