Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/sphinx-doc/sphinx.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2020-07-16 19:01:51 +0300
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2021-04-07 19:54:17 +0300
commiteb68c237dddbceecb7a295642e51e4ac8a5b36c2 (patch)
tree5cd9f57808fe4dd067b1d75d840157c8d5129e63 /sphinx/setup_command.py
parent245b3c32df1965b6bd5952cf25e19beef965a01b (diff)
refactor: Use PEP-526 based variable annotation
Diffstat (limited to 'sphinx/setup_command.py')
-rw-r--r--sphinx/setup_command.py24
1 files changed, 9 insertions, 15 deletions
diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py
index a508c50a1..62c83a911 100644
--- a/sphinx/setup_command.py
+++ b/sphinx/setup_command.py
@@ -16,7 +16,7 @@ import sys
from distutils.cmd import Command
from distutils.errors import DistutilsExecError
from io import StringIO
-from typing import TYPE_CHECKING
+from typing import Any, Dict
from sphinx.application import Sphinx
from sphinx.cmd.build import handle_exception
@@ -24,9 +24,6 @@ from sphinx.util.console import color_terminal, nocolor
from sphinx.util.docutils import docutils_namespace, patch_docutils
from sphinx.util.osutil import abspath
-if TYPE_CHECKING:
- from typing import Any, Dict
-
class BuildDoc(Command):
"""
@@ -91,18 +88,18 @@ class BuildDoc(Command):
boolean_options = ['fresh-env', 'all-files', 'warning-is-error',
'link-index', 'nitpicky']
- def initialize_options(self):
- # type: () -> None
+ def initialize_options(self) -> None:
self.fresh_env = self.all_files = False
self.pdb = False
- self.source_dir = self.build_dir = None # type: str
+ self.source_dir: str = None
+ self.build_dir: str = None
self.builder = 'html'
self.warning_is_error = False
self.project = ''
self.version = ''
self.release = ''
self.today = ''
- self.config_dir = None # type: str
+ self.config_dir: str = None
self.link_index = False
self.copyright = ''
# Link verbosity to distutils' (which uses 1 by default).
@@ -111,8 +108,7 @@ class BuildDoc(Command):
self.nitpicky = False
self.keep_going = False
- def _guess_source_dir(self):
- # type: () -> str
+ def _guess_source_dir(self) -> str:
for guess in ('doc', 'docs'):
if not os.path.isdir(guess):
continue
@@ -121,8 +117,7 @@ class BuildDoc(Command):
return root
return os.curdir
- def finalize_options(self):
- # type: () -> None
+ def finalize_options(self) -> None:
self.ensure_string_list('builder')
if self.source_dir is None:
@@ -144,15 +139,14 @@ class BuildDoc(Command):
(builder, os.path.join(self.build_dir, builder))
for builder in self.builder]
- def run(self):
- # type: () -> None
+ def run(self) -> None:
if not color_terminal():
nocolor()
if not self.verbose: # type: ignore
status_stream = StringIO()
else:
status_stream = sys.stdout # type: ignore
- confoverrides = {} # type: Dict[str, Any]
+ confoverrides: Dict[str, Any] = {}
if self.project:
confoverrides['project'] = self.project
if self.version: