summaryrefslogtreecommitdiff
path: root/sphinx/quickstart.py
diff options
context:
space:
mode:
authorAlastair Houghton <alastair@alastairs-place.net>2015-01-13 18:31:23 +0000
committerAlastair Houghton <alastair@alastairs-place.net>2015-01-13 18:31:23 +0000
commit8b0770126f00c0f885e654f127ebf5e03cfd42e0 (patch)
treea633d139ef7f585fca84bcd604bd8cabf02cdec8 /sphinx/quickstart.py
parentb90f319e371744fb017b5ce3c9de1c2d58816aa3 (diff)
downloadsphinx-git-8b0770126f00c0f885e654f127ebf5e03cfd42e0.tar.gz
More changes for Apple Help support.
Diffstat (limited to 'sphinx/quickstart.py')
-rw-r--r--sphinx/quickstart.py16
1 files changed, 11 insertions, 5 deletions
diff --git a/sphinx/quickstart.py b/sphinx/quickstart.py
index 2d2e33405..049cc477a 100644
--- a/sphinx/quickstart.py
+++ b/sphinx/quickstart.py
@@ -269,20 +269,26 @@ htmlhelp_basename = '%(project_fn)sdoc'
# -- Options for Apple Help output ----------------------------------------
-# The bundle name.
+# The help file title.
+#
+# This needs to go in the CFBundleHelpBookName field in your application,
+# and is displayed in the title bar of the help viewer.
+#applehelp_title = u'%(project_str)s Help'
+
+# The name of the bundle.
#applehelp_bundle_name = u'%(project_fn)s'
# The bundle id.
#applehelp_bundle_id = 'com.mycompany.%(project_url)s.help'
-# The development region. Should be 'en_us' in most cases.
-#applehelp_dev_region = 'en_us'
+# The development region. Should be 'en-us' in most cases.
+#applehelp_dev_region = 'en-us'
# The bundle version.
-#applehelp_bundle_version = 1
+#applehelp_bundle_version = '1'
# The icon file
-#applehelp_icon = '%(project_fn)s.icns'
+#applehelp_icon = '%(project_fn)s.png'
# These allow remote searching of a knowledge base on your server
#applehelp_kb_url = "https://kb.example.com/search?p='product'&q='query'&l='lang'"