unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
* Embed elisp.py from flycheck, use it in notmuch-emacs doc
@ 2022-07-31 11:33 David Bremner
  2022-07-31 11:33 ` [PATCH 1/7] doc: copy elisp.py from flycheck, make available David Bremner
                   ` (7 more replies)
  0 siblings, 8 replies; 10+ messages in thread
From: David Bremner @ 2022-07-31 11:33 UTC (permalink / raw)
  To: notmuch

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


^ permalink raw reply	[flat|nested] 10+ messages in thread

end of thread, other threads:[~2022-08-11 10:51 UTC | newest]

Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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 ` Embed elisp.py from flycheck, use it in notmuch-emacs doc Tomi Ollila
2022-08-11 10:51   ` David Bremner

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).