sphinx_applehelp_builder_configuration_for_apple_help_book.py

1# Configuration file for the Sphinx documentation builder.
2# This file only contains a selection of the most common options.
3
4# -- Project information -----------------------------------------------------
5
6project = 'My Apple Help Project'
7copyright = '2024, Author'
8author = 'Author'
9
10# -- General configuration ---------------------------------------------------
11
12# Add 'sphinxcontrib.applehelp' to extensions if using Sphinx < 2.0, 
13# otherwise it is often built-in or loaded automatically when the builder is used.
14extensions = [
15    'sphinxcontrib.applehelp',
16]
17
18# -- Options for Apple Help output -------------------------------------------
19
20# The basename for the Apple Help Book.
21applehelp_bundle_name = 'MyProjectHelp'
22
23# The help bundle identifier.
24applehelp_bundle_id = 'com.mycompany.myproject.help'
25
26# The title for the help book.
27applehelp_title = 'My Project Help'
28
29# The icon for the help book (optional).
30# applehelp_icon = 'help-icon.png'
31
32# The path to the Apple Help Indexing Tool.
33# applehelp_indexer_path = '/usr/bin/hiutil'
34
35# The path to the Help Viewer application.
36# applehelp_viewer_path = '/usr/bin/open'