From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp12.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id yL5fD1HavmJbkAAAbAwnHQ (envelope-from ) for ; Fri, 01 Jul 2022 13:28:17 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp12.migadu.com with LMTPS id 0IQjD1HavmKsgwEAauVa8A (envelope-from ) for ; Fri, 01 Jul 2022 13:28:17 +0200 Received: from mail.notmuchmail.org (yantan.tethera.net [IPv6:2a01:4f9:c011:7a79::1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 127881DBDA for ; Fri, 1 Jul 2022 13:28:17 +0200 (CEST) Received: from yantan.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id 12C495F7E1; Fri, 1 Jul 2022 11:28:14 +0000 (UTC) Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197]) by mail.notmuchmail.org (Postfix) with ESMTP id 6E3DE5F7CC for ; Fri, 1 Jul 2022 11:28:10 +0000 (UTC) Received: by fethera.tethera.net (Postfix, from userid 1001) id E10015FBD0; Fri, 1 Jul 2022 07:28:09 -0400 (EDT) Received: (nullmailer pid 31983 invoked by uid 1000); Fri, 01 Jul 2022 11:28:07 -0000 From: David Bremner To: notmuch@notmuchmail.org Subject: [PATCH] doc: improve config item labels in info output Date: Fri, 1 Jul 2022 08:28:01 -0300 Message-Id: <20220701112801.31971-1-david@tethera.net> X-Mailer: git-send-email 2.35.2 MIME-Version: 1.0 Message-ID-Hash: 5EOEH5APGPYBUENYWVNYDIOGV2UGPLV2 X-Message-ID-Hash: 5EOEH5APGPYBUENYWVNYDIOGV2UGPLV2 X-MailFrom: bremner@tethera.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-notmuch.notmuchmail.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.3 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Migadu-Flow: FLOW_IN X-Migadu-To: larch@yhetil.org X-Migadu-Country: DE ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1656674897; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding:list-id:list-help: list-owner:list-unsubscribe:list-subscribe:list-post; bh=4UbG6RLLXyOy8ZI8xe8wgMSgg/68W4NhXmX+X8XEX5w=; b=njqMqR3oo6LfD8AJXlAMebizUudx75t6Zkrf1CI3+G0CtuOxkPTv+CQ2FUvxXgc1CQ/jCL PLoz9eClw1mTRQE19SrH0A+GV0UkRa0Vn04Xnw/O+uYZVrwmA42kxI9YimCFGfbhd/CF1n LKO/Lxvf+Mh4UasW6sBkHjULYJhQGospwB6gYduupLZhv1Emue7njm33b0LdI142jFSF9S gA+GGUQlSF/C1E7OmvObYGyA+YZDkEdCLJBEibV9P4yMqvjbmJQhYJAtnbrNNsnqyhD5/3 oYt/EUSAFVLZgG9tjscf8xHM3ic6AOK6pGMI5+4uc0V87zzylVroEkocyxixEQ== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1656674897; a=rsa-sha256; cv=none; b=JNLTKEIXZ19Ed4lW+GmAPfhSrnN8w9cs5XwwYgUED0aOWmU3jkgUB1v0Ypsi6BQtUJAZnh 4GNQHkx03e6ikcwQDSA3l3ImyByIlJuNmebKWNLEChEiV+zSxpabEOKcJRxXCbXYNbM0uh i3MWXeJJU5eEvAN0xa9WhF8qhpABb9VKwQ+zoXLBdq4RyeNQJxiZNgudNHUgqbz127BOSV S7oAyH1yq8FYuQ4O3TonQ0xopbilrdTmRAj9qViA9EM31LmfPF3BpVKkU50i6FjF89l8TT OTsDLN1EOFzlUtu3dY9VHztIsRXY3B4SXYAcnMpQiQlR6RiezHSs7B8wDn2r/g== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 2a01:4f9:c011:7a79::1 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Spam-Score: -1.20 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 2a01:4f9:c011:7a79::1 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Queue-Id: 127881DBDA X-Spam-Score: -1.20 X-Migadu-Scanner: scn0.migadu.com X-TUID: IefndbS5u8SM Commit 306b7028d added the nmconfig role / directive. Unfortunately the default of using the directive name in texinfo output is pretty ugly, so attempt to make it more human readable by passing `objname` to add_object_type invocation. --- doc/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index f01c0058..70dd3059 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -210,4 +210,5 @@ def setup(app): # define nmconfig role and directive for config items. app.add_object_type('nmconfig','nmconfig', indextemplate='pair: configuration item; %s', - ref_nodeclass=docutils.nodes.generated) + ref_nodeclass=docutils.nodes.generated, + objname='config item' ) -- 2.35.2