summaryrefslogtreecommitdiff
path: root/sphinx/builders/applehelp.py
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2016-11-08 17:47:52 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2016-11-16 12:06:22 +0900
commit23b1c3d5f203972d1d7a254594f0e7ca4baf7b59 (patch)
treee0b9f00c15d4c5e732365705e41c33d27ae78bfa /sphinx/builders/applehelp.py
parent8a06a42c311c58dcab1116e06b3afbc2541f49f1 (diff)
downloadsphinx-git-23b1c3d5f203972d1d7a254594f0e7ca4baf7b59.tar.gz
Add type-check annotations to sphinx.builders
Diffstat (limited to 'sphinx/builders/applehelp.py')
-rw-r--r--sphinx/builders/applehelp.py12
1 files changed, 10 insertions, 2 deletions
diff --git a/sphinx/builders/applehelp.py b/sphinx/builders/applehelp.py
index 7db086953..c674204fc 100644
--- a/sphinx/builders/applehelp.py
+++ b/sphinx/builders/applehelp.py
@@ -19,7 +19,7 @@ import shlex
from sphinx.builders.html import StandaloneHTMLBuilder
from sphinx.config import string_classes
from sphinx.util.osutil import copyfile, ensuredir, make_filename
-from sphinx.util.console import bold
+from sphinx.util.console import bold # type: ignore
from sphinx.util.fileutil import copy_asset
from sphinx.util.pycompat import htmlescape
from sphinx.util.matching import Matcher
@@ -28,10 +28,13 @@ from sphinx.errors import SphinxError
import plistlib
import subprocess
+if False:
+ # For type annotation
+ from sphinx.application import Sphinx # NOQA
# Use plistlib.dump in 3.4 and above
try:
- write_plist = plistlib.dump
+ write_plist = plistlib.dump # type: ignore
except AttributeError:
write_plist = plistlib.writePlist
@@ -83,6 +86,7 @@ class AppleHelpBuilder(StandaloneHTMLBuilder):
search = False
def init(self):
+ # type: () -> None
super(AppleHelpBuilder, self).init()
# the output files for HTML help must be .html only
self.out_suffix = '.html'
@@ -101,12 +105,14 @@ class AppleHelpBuilder(StandaloneHTMLBuilder):
self.config.applehelp_locale + '.lproj')
def handle_finish(self):
+ # type: () -> None
super(AppleHelpBuilder, self).handle_finish()
self.finish_tasks.add_task(self.copy_localized_files)
self.finish_tasks.add_task(self.build_helpbook)
def copy_localized_files(self):
+ # type: () -> None
source_dir = path.join(self.confdir, self.config.applehelp_locale + '.lproj')
target_dir = self.outdir
@@ -120,6 +126,7 @@ class AppleHelpBuilder(StandaloneHTMLBuilder):
self.info('done')
def build_helpbook(self):
+ # type: () -> None
contents_dir = path.join(self.bundle_path, 'Contents')
resources_dir = path.join(contents_dir, 'Resources')
language_dir = path.join(resources_dir,
@@ -264,6 +271,7 @@ class AppleHelpBuilder(StandaloneHTMLBuilder):
def setup(app):
+ # type: (Sphinx) -> None
app.setup_extension('sphinx.builders.html')
app.add_builder(AppleHelpBuilder)