{"id":950,"library":"sphinxcontrib-applehelp","title":"Sphinx AppleHelp Extension","description":"sphinxcontrib-applehelp is a Sphinx extension which outputs Apple Help Books. It is maintained by the Sphinx project and has an irregular but generally active release cadence, with version 2.0.0 released in July 2024.","status":"active","version":"2.0.0","language":"python","source_language":"en","source_url":"https://github.com/sphinx-doc/sphinxcontrib-applehelp/","tags":["sphinx","documentation","apple","helpbook","extension"],"install":[{"cmd":"pip install sphinxcontrib-applehelp","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Runtime dependency for Sphinx documentation generation.","package":"Sphinx","version":">=5.0"}],"imports":[{"note":"To enable the extension in Sphinx, add 'sphinxcontrib.applehelp' to the 'extensions' list in your conf.py.","symbol":"applehelp","correct":"extensions = ['sphinxcontrib.applehelp']"}],"quickstart":{"code":"# conf.py\nproject = 'My Project'\ncopyright = '2026, My Team'\nextensions = [\n    'sphinxcontrib.applehelp'\n]\n\n# To build from your documentation root:\n# sphinx-build -b applehelp . _build/applehelp","lang":"python","description":"After installing, enable the extension by adding 'sphinxcontrib.applehelp' to the `extensions` list in your Sphinx `conf.py`. Then, build the documentation using the 'applehelp' builder."},"warnings":[{"fix":"Upgrade your Sphinx installation to version 5.0 or newer (e.g., `pip install -U Sphinx`). If compatibility with older Sphinx versions is required, pin `sphinxcontrib-applehelp` to an older version (e.g., `==1.0.4`).","message":"sphinxcontrib-applehelp 2.0.0 (and recent 1.x versions) requires Sphinx v5.0 or later. Building with older Sphinx versions will result in a `sphinx.errors.VersionRequirementError`.","severity":"breaking","affected_versions":">=1.0.5 (specifically 1.0.8, 2.0.0)"},{"fix":"Upgrade sphinxcontrib-applehelp to the latest version (2.0.0 or newer) to resolve these warnings.","message":"Older versions of sphinxcontrib-applehelp (e.g., 1.0.2, 1.0.7) may produce `RemovedInSphinx80Warning` due to deprecated aliases like `sphinx.util.SkipProgressMessage` and `sphinx.util.progress_message`.","severity":"deprecated","affected_versions":"<2.0.0"},{"fix":"Ensure you are using a compatible Sphinx version (>=2.0) and that the extension is correctly added to `extensions` in `conf.py`.","message":"The builder name 'applehelp' was moved from `sphinx.builders` to `sphinxcontrib.applehelp` in Sphinx 2.0. While this is a Sphinx core change, it solidifies the usage pattern for this extension.","severity":"gotcha","affected_versions":"Sphinx <2.0"},{"fix":"Ensure modern packaging practices (e.g., `pyproject.toml`) and up-to-date `setuptools` are used. For older environments, explicitly pin `sphinxcontrib-applehelp` to a compatible version if build issues related to dependency resolution occur.","message":"Historically, there have been issues with package naming conventions (hyphens vs. dots in `setup_requires` lists) that could lead to build failures with older setuptools versions when Sphinx implicitly depended on `sphinxcontrib-applehelp`.","severity":"gotcha","affected_versions":"Older Sphinx/setuptools versions (e.g., Python 3.8, setuptools 56.0.0)"}],"env_vars":null,"search_vec":"'2.0.0':34 '2024':38 'activ':29 'appl':13,41 'applehelp':2,6 'book':15 'cadenc':31 'document':40 'extens':3,10,43 'general':28 'help':14 'helpbook':42 'irregular':26 'juli':37 'maintain':18 'output':12 'project':22 'releas':30,35 'sphinx':1,9,21,39 'sphinxcontrib':5 'sphinxcontrib-applehelp':4 'version':33","created_at":"2026-03-29T06:09:08.543499+00:00","updated_at":"2026-04-16T22:05:15.620715+00:00","problems":{"verify_error":"no import statement found"},"ecosystem":"pypi","meta_description":null,"install_score":80,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":"2.0.0","cli_name":"","cli_version":null,"type":"library","homepage":"https://www.sphinx-doc.org/","github":"https://github.com/sphinx-doc/sphinxcontrib-applehelp","docs":null,"changelog":"https://github.com/sphinx-doc/sphinxcontrib-applehelp/blob/master/CHANGES.rst","pypi":"https://pypi.org/project/sphinxcontrib-applehelp/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["web-framework"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"passing","verified_at":"2026-06-28","last_verified":"2026-08-27","next_check":"2026-07-05","install_tag":"verified"}}