Skip to content

Close #9820: Use setuptools.Command if available #10490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tk0miya merged 1 commit into from
Jun 6, 2022
Merged

Close #9820: Use setuptools.Command if available #10490

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions sphinx/setup_command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
import os
import sys
import warnings
from distutils.cmd import Command
from distutils.errors import DistutilsExecError
from io import StringIO
from typing import Any, Dict

Expand All @@ -18,6 +16,13 @@
from sphinx.util.docutils import docutils_namespace, patch_docutils
from sphinx.util.osutil import abspath

try:
from setuptools import Command
from setuptools.errors import ExecError
except ImportError:
from distutils.cmd import Command
from distutils.errors import DistutilsExecError as ExecError


class BuildDoc(Command):
"""
Expand Down Expand Up @@ -97,7 +102,7 @@ def initialize_options(self) -> None:
self.link_index = False
self.copyright = ''
# Link verbosity to distutils' (which uses 1 by default).
self.verbosity = self.distribution.verbose - 1 # type: ignore
self.verbosity = self.distribution.verbose - 1
self.traceback = False
self.nitpicky = False
self.keep_going = False
Expand Down Expand Up @@ -125,7 +130,7 @@ def finalize_options(self) -> None:

if self.build_dir is None:
build = self.get_finalized_command('build')
self.build_dir = os.path.join(abspath(build.build_base), 'sphinx') # type: ignore
self.build_dir = os.path.join(abspath(build.build_base), 'sphinx')

self.doctree_dir = os.path.join(self.build_dir, 'doctrees')

Expand All @@ -139,7 +144,7 @@ def run(self) -> None:

if not color_terminal():
nocolor()
if not self.verbose: # type: ignore
if not self.verbose:
status_stream = StringIO()
else:
status_stream = sys.stdout # type: ignore
Expand Down Expand Up @@ -171,8 +176,7 @@ def run(self) -> None:
verbosity=self.verbosity, keep_going=self.keep_going)
app.build(force_all=self.all_files)
if app.statuscode:
raise DistutilsExecError(
'caused by %s builder.' % app.builder.name)
raise ExecError('caused by %s builder.' % app.builder.name)
except Exception as exc:
handle_exception(app, self, exc, sys.stderr)
if not self.pdb:
Expand Down