File: //usr/lib/python3/dist-packages/sphinx/__pycache__/setup_command.cpython-310.pyc
o
�$�ap � @ s� d Z ddlZddlZddlmZ ddlmZ ddlmZ ddl m
Z
mZ ddlm
Z
ddlmZ dd lmZmZ dd
lmZmZ ddlmZ G dd
� d
e�ZdS )a?
sphinx.setup_command
~~~~~~~~~~~~~~~~~~~~
Setuptools/distutils commands to assist the building of sphinx
documentation.
:author: Sebastian Wiesner
:contact: basti.wiesner@gmx.net
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)�Command)�DistutilsExecError)�StringIO)�Any�Dict)�Sphinx)�handle_exception)�color_terminal�nocolor)�docutils_namespace�patch_docutils)�abspathc @ sP e Zd ZdZdZg d�Zg d�Zddd�Zdefd d
�Z ddd�Z
dd
d�ZdS )�BuildDoca9
Distutils command to build Sphinx documentation.
The Sphinx build can then be triggered from distutils, and some Sphinx
options can be set in ``setup.py`` or ``setup.cfg`` instead of Sphinx's
own configuration file.
For instance, from `setup.py`::
# this is only necessary when not using setuptools/distribute
from sphinx.setup_command import BuildDoc
cmdclass = {'build_sphinx': BuildDoc}
name = 'My project'
version = '1.2'
release = '1.2.0'
setup(
name=name,
author='Bernard Montgomery',
version=release,
cmdclass=cmdclass,
# these are optional and override conf.py settings
command_options={
'build_sphinx': {
'project': ('setup.py', name),
'version': ('setup.py', version),
'release': ('setup.py', release)}},
)
Or add this section in ``setup.cfg``::
[build_sphinx]
project = 'My project'
version = 1.2
release = 1.2.0
zBuild Sphinx documentation))� fresh-env�Ezdiscard saved environment)� all-files�azbuild all files)zsource-dir=�szSource directory)z
build-dir=NzBuild directory)zconfig-dir=�cz'Location of the configuration directory)zbuilder=�bz]The builder (or builders) to use. Can be a comma- or space-separated list. Defaults to "html")�warning-is-error�WzTurn warning into errors)zproject=NzThe documented project's name)zversion=NzThe short X.Y version)zrelease=Nz.The full version, including alpha/beta/rc tags)ztoday=NzCHow to format the current date, used as the replacement for |today|)�
link-index�iz!Link index.html to the master doc)� copyrightNzThe copyright string)�pdbNzStart pdb on exception)� verbosity�vz$increase verbosity (can be repeated))�nitpicky�nz1nit-picky mode, warn about all missing references)z
keep-goingNz)With -W, keep going when getting warnings)r r r r r �returnNc C sx d | _ | _d| _d | _d | _d| _d| _d| _d| _d| _ d| _
d | _d| _d| _
| jjd | _d| _d| _d| _d S )NF�html� � )� fresh_env� all_filesr �
source_dir� build_dir�builder�warning_is_error�project�version�release�today�
config_dir�
link_indexr �distribution�verboser � tracebackr �
keep_going��self� r6 �6/usr/lib/python3/dist-packages/sphinx/setup_command.py�initialize_options[ s"