aboutsummaryrefslogtreecommitdiff
path: root/doc/elisp.py
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2022-07-31 08:33:20 -0300
committerDavid Bremner <david@tethera.net>2022-08-11 07:43:17 -0300
commit174221b179380ec76b34088cdf9cb694ecacf241 (patch)
tree72f82f1615f00ad8d6ceb0bf2c6ded95df247763 /doc/elisp.py
parentfe3db23684c9de5b879733b7c7e3f7bbffbee026 (diff)
doc/emacs: split index category from label
A more verbose category is needed for the index, but not the description in the manual.
Diffstat (limited to 'doc/elisp.py')
-rw-r--r--doc/elisp.py14
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/elisp.py b/doc/elisp.py
index b8b4931b..1b0392e6 100644
--- a/doc/elisp.py
+++ b/doc/elisp.py
@@ -110,6 +110,13 @@ class EmacsLispSymbol(ObjectDescription):
'defface': 'face'
}
+ category_for_objtype = {
+ 'defcustom': 'Emacs variable (customizable)',
+ 'defconst': 'Emacs constant',
+ 'defvar': 'Emacs variable',
+ 'defface': 'Emacs face'
+ }
+
@property
def cell(self):
"""The cell in which to store symbol metadata."""
@@ -120,6 +127,11 @@ class EmacsLispSymbol(ObjectDescription):
"""The label for the documented object type."""
return self.objtype
+ @property
+ def category(self):
+ """Index category"""
+ return self.category_for_objtype[self.objtype]
+
def handle_signature(self, signature, signode):
"""Create nodes in ``signode`` for the ``signature``.
@@ -137,7 +149,7 @@ class EmacsLispSymbol(ObjectDescription):
def _add_index(self, name, target):
index_text = '{name}; {label}'.format(
- name=name, label=self.label)
+ name=name, label=self.category)
self.indexnode['entries'].append(
('pair', index_text, target, '', None))