From: Tomi Ollila <tomi.ollila@iki.fi>
To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
Subject: Re: Embed elisp.py from flycheck, use it in notmuch-emacs doc
Date: Wed, 10 Aug 2022 23:09:03 +0300 [thread overview]
Message-ID: <y3do0kv.d0hw7d-too@iki.fi> (raw)
In-Reply-To: <20220731113323.2845595-1-david@tethera.net>
On Sun, Jul 31 2022, David Bremner wrote:
> 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.
This series is probably good; at least it does not break software
(and if doc quality (or making of it) gets better then good :D)
Tomi
>
> [1]: id:20180521200856.17103-1-david@tethera.net
>
>
> _______________________________________________
> notmuch mailing list -- notmuch@notmuchmail.org
> To unsubscribe send an email to notmuch-leave@notmuchmail.org
next prev parent reply other threads:[~2022-08-10 20:09 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-31 11:33 Embed elisp.py from flycheck, use it in notmuch-emacs doc David Bremner
2022-07-31 11:33 ` [PATCH 1/7] doc: copy elisp.py from flycheck, make available David Bremner
2022-07-31 11:33 ` [PATCH 2/7] doc/elisp: replace label for Emacs commands and key bindings David Bremner
2022-07-31 11:33 ` [PATCH 3/7] doc/emacs: drop domain label David Bremner
2022-07-31 11:33 ` [PATCH 4/7] doc/emacs: split index category from label David Bremner
2022-07-31 11:33 ` [PATCH 5/7] doc/emacs: replace emacscmd with el:define-key David Bremner
2022-07-31 11:33 ` [PATCH 6/7] doc/emacs: replace use of emacsvar with el:defcustom David Bremner
2022-07-31 11:33 ` [PATCH 7/7] doc/emacs: use define-key instead of hard-coding markup David Bremner
2022-08-10 20:09 ` Tomi Ollila [this message]
2022-08-11 10:51 ` Embed elisp.py from flycheck, use it in notmuch-emacs doc David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=y3do0kv.d0hw7d-too@iki.fi \
--to=tomi.ollila@iki.fi \
--cc=david@tethera.net \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).