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 iKdQNI1o5mLAnQAAbAwnHQ (envelope-from ) for ; Sun, 31 Jul 2022 13:33:33 +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 sBQbNI1o5mIVMAEAauVa8A (envelope-from ) for ; Sun, 31 Jul 2022 13:33:33 +0200 Received: from mail.notmuchmail.org (yantan.tethera.net [135.181.149.255]) (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 8A7781EDA7 for ; Sun, 31 Jul 2022 13:33:33 +0200 (CEST) Received: from yantan.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id 2190D5E022; Sun, 31 Jul 2022 11:33:30 +0000 (UTC) Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197]) by mail.notmuchmail.org (Postfix) with ESMTP id 658B75DD92 for ; Sun, 31 Jul 2022 11:33:28 +0000 (UTC) Received: by fethera.tethera.net (Postfix, from userid 1001) id 5942E5FBC0; Sun, 31 Jul 2022 07:33:27 -0400 (EDT) Received: (nullmailer pid 2850495 invoked by uid 1000); Sun, 31 Jul 2022 11:33:26 -0000 From: David Bremner To: notmuch@notmuchmail.org Subject: Embed elisp.py from flycheck, use it in notmuch-emacs doc Date: Sun, 31 Jul 2022 08:33:16 -0300 Message-Id: <20220731113323.2845595-1-david@tethera.net> X-Mailer: git-send-email 2.35.2 MIME-Version: 1.0 Message-ID-Hash: B4ZBKT4WQ4NK45E6QYXJ3ZAZ3ZKXJMQL X-Message-ID-Hash: B4ZBKT4WQ4NK45E6QYXJ3ZAZ3ZKXJMQL 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=1659267213; 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=jaQGVdipZ7Wbg4CxSbyoy9e2t08T9RiH+PSEcIeMxHo=; b=A4mCY/xsuAARNIJo99vhq7qEcOIDAC4jW8JeDkSehOW0q2BVZgOU9L2MZvH64O9Wjvcvfx QlTSycnHwmf5cQtbSC/R0G6paxshcDfpaciGWNyQj8Lhh7/X2Bj1t7E6g4bg84r1uf0eQc wxGZgoBY/R5jeOHphRybuZVWEhJCL3C0zteAwNe2koIma/0DHXwAs5gDWqEnNssrZ3s9bR VKhPbcjyaS8FK8BcjpWjCoBUX4IArRXkKM4cKV0RVc/6qdDmilvRixS0ECWa7NG8bjzzkn h4m+Xqfybn8FIe2Gyyf1dctQKxgZhUn4mG1RSC5EFikhfy86czzJZxfhI6FIqA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1659267213; a=rsa-sha256; cv=none; b=M7Sefd34zk50DJdqZ1BUbMA60hvD0hE+daLJB0rAypmGAJrHC5ou4cSClSjlMZXXQ1wQTk KWvlaOziYkM0dZoJ2ez5cP2F23R8nipgnSfkTtD/oX13JI/ckOfcuuKiH70fyONaoHfKc5 2e0GkB8XVdADm9IhpS6VMYNwnWzlutHsFq6wvLTY2WlyczdfHO8WId6/HAaBSpE9GqiCPe 7CDqL2SVPK3OXgG/M18WR09YuiOXl48WzvHf/bJvqkd8CbbZqOo9haJgxpI195kvvfL5YO OsSpRtrhMAcwGcX9y65h9RJ/7Fu0axEXYkdUp6quBCBtSTo669EhMWcF99xmAg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 135.181.149.255 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Spam-Score: -1.77 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 135.181.149.255 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Queue-Id: 8A7781EDA7 X-Spam-Score: -1.77 X-Migadu-Scanner: scn0.migadu.com X-TUID: cPp1XA9BJcXU After finding myself spending a while trying to re-create one of the features [0] of the el sphinx domain used in flycheck, I decided to try just converting the docs to use that sphinx extension. As I remarked in 2018 [1], there doesn't seem to be a distributed version of this sphinx extension. It also seems like the use-case in notmuch is a bit different in terms of what we want to put in the index, but perhaps someone better at sphinx than I could do those customizations without modifying the extension (as this series does). Overall I think the quality of the resulting HTML documentation is quite nice. The change in the info documentation is less clear. This may also be tweakable, but in the first version the info docs seem more verbose than necessary (e.g. writing "Key Binding" everywhere) On the other hand, if it encourages people (e.g. me) to document things, then it's probably a win overall. [0]: documenting both a keybinding and a function name with the same directive, with nice index entries. [1]: id:20180521200856.17103-1-david@tethera.net