You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
65 lines
2.2 KiB
65 lines
2.2 KiB
"""
|
|
Sphinx
|
|
~~~~~~
|
|
|
|
The Sphinx documentation toolchain.
|
|
|
|
:copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
# Keep this file executable as-is in Python 3!
|
|
# (Otherwise getting the version out of it from setup.py is impossible.)
|
|
|
|
import os
|
|
import subprocess
|
|
import warnings
|
|
from os import path
|
|
from subprocess import PIPE
|
|
|
|
from .deprecation import RemovedInNextVersionWarning
|
|
|
|
if False:
|
|
# For type annotation
|
|
from typing import Any # NOQA
|
|
|
|
|
|
# by default, all DeprecationWarning under sphinx package will be emit.
|
|
# Users can avoid this by using environment variable: PYTHONWARNINGS=
|
|
if 'PYTHONWARNINGS' not in os.environ:
|
|
warnings.filterwarnings('default', category=RemovedInNextVersionWarning)
|
|
# docutils.io using mode='rU' for open
|
|
warnings.filterwarnings('ignore', "'U' mode is deprecated",
|
|
DeprecationWarning, module='docutils.io')
|
|
|
|
__version__ = '3.4.0'
|
|
__released__ = '3.4.0' # used when Sphinx builds its own docs
|
|
|
|
#: Version info for better programmatic use.
|
|
#:
|
|
#: A tuple of five elements; for Sphinx version 1.2.1 beta 3 this would be
|
|
#: ``(1, 2, 1, 'beta', 3)``. The fourth element can be one of: ``alpha``,
|
|
#: ``beta``, ``rc``, ``final``. ``final`` always has 0 as the last element.
|
|
#:
|
|
#: .. versionadded:: 1.2
|
|
#: Before version 1.2, check the string ``sphinx.__version__``.
|
|
version_info = (3, 4, 0, 'final', 0)
|
|
|
|
package_dir = path.abspath(path.dirname(__file__))
|
|
|
|
__display_version__ = __version__ # used for command line version
|
|
if __version__.endswith('+'):
|
|
# try to find out the commit hash if checked out from git, and append
|
|
# it to __version__ (since we use this value from setup.py, it gets
|
|
# automatically propagated to an installed copy as well)
|
|
__display_version__ = __version__
|
|
__version__ = __version__[:-1] # remove '+' for PEP-440 version spec.
|
|
try:
|
|
ret = subprocess.run(['git', 'show', '-s', '--pretty=format:%h'],
|
|
cwd=package_dir,
|
|
stdout=PIPE, stderr=PIPE)
|
|
if ret.stdout:
|
|
__display_version__ += '/' + ret.stdout.decode('ascii').strip()
|
|
except Exception:
|
|
pass
|