htmlhelp Namespace Reference

Classes
class	HTMLHelpBuilder
class	ToCTreeVisitor

Functions
str	chm_htmlescape (str s, bool quote=True)
str	default_htmlhelp_basename (Config config)
dict[str, Any]	setup (Sphinx app)

Variables
	logger = logging.getLogger(__name__)
	package_dir = path.abspath(path.dirname(__file__))
	template_dir = path.join(package_dir, 'templates')
dict	chm_locales

Detailed Description

Build HTML help support files.

Function Documentation

chm_htmlescape()

str htmlhelp.chm_htmlescape	(	str	s,
		bool	quote = True
	)

chm_htmlescape() is a wrapper of html.escape().
.hhc/.hhk files don't recognize hex escaping, we need convert
hex escaping to decimal escaping. for example: ``'`` -> ``'``
html.escape() may generates a hex escaping ``'`` for single
quote ``'``, this wrapper fixes this.

default_htmlhelp_basename()

str htmlhelp.default_htmlhelp_basename

(

Config

config

)

Better default htmlhelp_basename setting.