doc/emacs: replace emacscmd with el:define-key

This allows us to eliminate the ad-hoc emacscmd directive / role, and
improve indexing.

doc/emacs: convert remaining uses of emacscmd to define-key

This allows us to remove the no-longer used object type.
This commit is contained in:
David Bremner 2022-07-31 08:33:21 -03:00
parent 174221b179
commit 0f3b196144
2 changed files with 10 additions and 16 deletions

View file

@ -228,8 +228,3 @@ def setup(app):
indextemplate='pair: Emacs variable; %s', indextemplate='pair: Emacs variable; %s',
ref_nodeclass=docutils.nodes.generated, ref_nodeclass=docutils.nodes.generated,
objname='Emacs variable') objname='Emacs variable')
app.add_object_type('emacscmd','emacscmd',
indextemplate='pair: Emacs command; %s',
ref_nodeclass=docutils.nodes.generated,
objname='Emacs command')

View file

@ -448,11 +448,8 @@ following example duplicate 3 of 5 is displayed.
Subject: Re: Multiple files per message in emacs Subject: Re: Multiple files per message in emacs
To: notmuch@notmuchmail.org To: notmuch@notmuchmail.org
To display a different message file with the same .. el:define-key:: %
:mailheader:`Message-ID`, the user can run the command M-x notmuch-show-choose-duplicate
:emacscmd:`notmuch-show-choose-duplicate`, by default bound to `%`.
.. emacscmd:: notmuch-show-choose-duplicate
|docstring::notmuch-show-choose-duplicate| |docstring::notmuch-show-choose-duplicate|
@ -568,7 +565,7 @@ following key bindings:
``k`` ``k``
Tagging operations using :ref:`notmuch-tag-jump` Tagging operations using :ref:`notmuch-tag-jump`
``C-_`` ``C-/`` ``C-x u``: Undo previous tagging operation using :ref:`notmuch-tag-undo` ``C-_`` ``C-/`` ``C-x u``: Undo previous tagging operation using :any:`notmuch-tag-undo`
.. _notmuch-jump: .. _notmuch-jump:
@ -599,7 +596,6 @@ operations specified in ``notmuch-tagging-keys``; i.e. each
|docstring::notmuch-tagging-keys| |docstring::notmuch-tagging-keys|
.. _notmuch-tag-undo:
notmuch-tag-undo notmuch-tag-undo
---------------- ----------------
@ -607,17 +603,20 @@ notmuch-tag-undo
Each notmuch buffer supporting tagging operations (i.e buffers in Each notmuch buffer supporting tagging operations (i.e buffers in
:any:`notmuch-show`, :any:`notmuch-search`, :any:`notmuch-tree`, and :any:`notmuch-show`, :any:`notmuch-search`, :any:`notmuch-tree`, and
:any:`notmuch-unthreaded` mode) keeps a local stack of tagging :any:`notmuch-unthreaded` mode) keeps a local stack of tagging
operations. These can be undone via :emacscmd:`notmuch-tag-undo`. By default operations. These can be undone via :any:`notmuch-tag-undo`. By default
this is bound to the usual Emacs keys for undo. this is bound to the usual Emacs keys for undo.
.. emacscmd:: notmuch-tag-undo .. el:define-key:: C-_
C-/
C-x u
M-x notmuch-tag-undo
|docstring::notmuch-tag-undo| |docstring::notmuch-tag-undo|
Buffer navigation Buffer navigation
================= =================
.. emacscmd:: notmuch-cycle-notmuch-buffers .. el:define-key:: M-x notmuch-cycle-notmuch-buffers
|docstring::notmuch-cycle-notmuch-buffers| |docstring::notmuch-cycle-notmuch-buffers|
@ -629,7 +628,7 @@ Configuration
Importing Mail Importing Mail
-------------- --------------
.. emacscmd:: notmuch-poll .. el:define-key:: M-x notmuch-poll
|docstring::notmuch-poll| |docstring::notmuch-poll|