Registry / web-framework / sphinxcontrib-applehelp

sphinxcontrib-applehelp

library2.0.0pypypi✓ verified 24d ago

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.

web-framework

pip install sphinxcontrib-applehelp

github ↗package ↗homepage ↗changelog ↗

INSTALL

IMPORT

SIG · SPHINXCONTRIB-APPL

sphinxcontrib-applehelp

web-frameworkpythonv2.0.0

Install

1.7s avg

Import

—

Disk

17MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v2.0.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 18.6MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 1.7s · import 0.000s · 19MB

17MB installed

● package 17MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

applehelp

✓ extensions = ['sphinxcontrib.applehelp']

To enable the extension in Sphinx, add 'sphinxcontrib.applehelp' to the 'extensions' list in your conf.py.

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.

# conf.py project = 'My Project' copyright = '2026, My Team' extensions = [ 'sphinxcontrib.applehelp' ] # To build from your documentation root: # sphinx-build -b applehelp . _build/applehelp

Debug

Known issues

breakingsphinxcontrib-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`.

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`).

affects: >=1.0.5 (specifically 1.0.8, 2.0.0)

deprecatedOlder 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`.

fix

Upgrade sphinxcontrib-applehelp to the latest version (2.0.0 or newer) to resolve these warnings.

affects: <2.0.0

gotchaThe 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.

fix

Ensure you are using a compatible Sphinx version (>=2.0) and that the extension is correctly added to `extensions` in `conf.py`.

affects: Sphinx <2.0

gotchaHistorically, 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`.

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.

affects: Older Sphinx/setuptools versions (e.g., Python 3.8, setuptools 56.0.0)

Upgrade

Version history

2.0.0latest on PyPI · released Jul 29, 2024

Audit

Dependencies

SphinxrequiredRuntime dependency for Sphinx documentation generation.

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/sphinx-doc/sphinxcontrib-applehelp ↗

packagehttps://pypi.org/project/sphinxcontrib-applehelp/ ↗

homepagehttps://www.sphinx-doc.org/ ↗

changeloghttps://github.com/sphinx-doc/sphinxcontrib-applehelp/blob/master/CHANGES.rst ↗