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.
48 lines
1.7 KiB
48 lines
1.7 KiB
"""
|
|
sphinx.builders.htmlhelp
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Build HTML help support files.
|
|
Parts adapted from Python's Doc/tools/prechm.py.
|
|
|
|
:copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
import warnings
|
|
from typing import Any, Dict
|
|
|
|
from sphinxcontrib.htmlhelp import (HTMLHelpBuilder, chm_htmlescape, chm_locales,
|
|
default_htmlhelp_basename)
|
|
|
|
from sphinx.application import Sphinx
|
|
from sphinx.deprecation import RemovedInSphinx40Warning, deprecated_alias
|
|
|
|
deprecated_alias('sphinx.builders.htmlhelp',
|
|
{
|
|
'chm_locales': chm_locales,
|
|
'chm_htmlescape': chm_htmlescape,
|
|
'HTMLHelpBuilder': HTMLHelpBuilder,
|
|
'default_htmlhelp_basename': default_htmlhelp_basename,
|
|
},
|
|
RemovedInSphinx40Warning,
|
|
{
|
|
'chm_locales': 'sphinxcontrib.htmlhelp.chm_locales',
|
|
'chm_htmlescape': 'sphinxcontrib.htmlhelp.chm_htmlescape',
|
|
'HTMLHelpBuilder': 'sphinxcontrib.htmlhelp.HTMLHelpBuilder',
|
|
'default_htmlhelp_basename':
|
|
'sphinxcontrib.htmlhelp.default_htmlhelp_basename',
|
|
})
|
|
|
|
|
|
def setup(app: Sphinx) -> Dict[str, Any]:
|
|
warnings.warn('sphinx.builders.htmlhelp has been moved to sphinxcontrib-htmlhelp.',
|
|
RemovedInSphinx40Warning, stacklevel=2)
|
|
app.setup_extension('sphinxcontrib.htmlhelp')
|
|
|
|
return {
|
|
'version': 'builtin',
|
|
'parallel_read_safe': True,
|
|
'parallel_write_safe': True,
|
|
}
|