Browse Source

Document defining multiple shortcuts

Thomas Kluyver 11 years ago
parent
commit
76d16b4704
2 changed files with 23 additions and 0 deletions
  1. 22 0
      doc/cfgfile.rst
  2. 1 0
      doc/releasenotes.rst

+ 22 - 0
doc/cfgfile.rst

@@ -57,6 +57,28 @@ Application section
    a console for the process. If ``false``, or not specified, they will use the
    ``pyw`` launcher, which doesn't create a console.
 
+Shortcut sections
+-----------------
+
+One shortcut will always be generated for the application. You can add extra
+shortcuts by defining sections titled :samp:`Shortcut {Name}`. For example:
+
+.. code-block:: ini
+
+    [Shortcut IPython Notebook]
+    entry_point=IPython.html.notebookapp:launch_new_instance
+    icon=scripts/ipython_nb.ico
+    console=true
+
+.. describe:: entry_point
+              script (optional)
+              icon (optional)
+              console (optional)
+
+   These options all work the same way as in the Application section.
+
+.. versionadded:: 0.2
+
 .. _cfg_python:
 
 Python section

+ 1 - 0
doc/releasenotes.rst

@@ -5,3 +5,4 @@ Version 0.2
 -----------
 
 * Python 2 support, thanks to `Johannes Baiter <https://github.com/jbaiter>`_
+* Ability to define multiple shortcuts for one application.