1"""
2    sphinx.builders.applehelp
3    ~~~~~~~~~~~~~~~~~~~~~~~~~
4
5    Build Apple help books.
6
7    :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
8    :license: BSD, see LICENSE for details.
9"""
10
11import warnings
12from typing import Any, Dict
13
14from sphinxcontrib.applehelp import (AppleHelpBuilder, AppleHelpCodeSigningFailed,
15                                     AppleHelpIndexerFailed)
16
17from sphinx.application import Sphinx
18from sphinx.deprecation import RemovedInSphinx40Warning, deprecated_alias
19
20deprecated_alias('sphinx.builders.applehelp',
21                 {
22                     'AppleHelpCodeSigningFailed': AppleHelpCodeSigningFailed,
23                     'AppleHelpIndexerFailed': AppleHelpIndexerFailed,
24                     'AppleHelpBuilder': AppleHelpBuilder,
25                 },
26                 RemovedInSphinx40Warning,
27                 {
28                     'AppleHelpCodeSigningFailed':
29                     'sphinxcontrib.applehelp.AppleHelpCodeSigningFailed',
30                     'AppleHelpIndexerFailed':
31                     'sphinxcontrib.applehelp.AppleHelpIndexerFailed',
32                     'AppleHelpBuilder': 'sphinxcontrib.applehelp.AppleHelpBuilder',
33                 })
34
35
36def setup(app: Sphinx) -> Dict[str, Any]:
37    warnings.warn('sphinx.builders.applehelp has been moved to sphinxcontrib-applehelp.',
38                  RemovedInSphinx40Warning, stacklevel=2)
39    app.setup_extension('sphinxcontrib.applehelp')
40
41    return {
42        'version': 'builtin',
43        'parallel_read_safe': True,
44        'parallel_write_safe': True,
45    }
46