[PATCH 1/3] emacs/rstdoc: escape '*'

[PATCH 1/3] emacs/rstdoc: escape '*'

[David Bremner]

This is just a regular character in docstrings (as it is fairly often
used in lisp identifiers and buffer names) but is the start of
emphasis in rst. This change is needed to quell a noisy warning when
including notmuch-tree.rsti
---
 emacs/rstdoc.el | 1 +
 1 file changed, 1 insertion(+)

diff --git a/emacs/rstdoc.el b/emacs/rstdoc.el
index c7c13015..5b8a9d01 100644
--- a/emacs/rstdoc.el
+++ b/emacs/rstdoc.el
@@ -71,6 +71,7 @@
      ("`" . "\\\\`")
      ("\001" . "'")
      ("\002" . "`")
+     ("[*]" . "\\\\*")
      ("^[[:space:]]*$" . "|br|")
      ("^[[:space:]]" . "|indent| "))
     "list of (regex . replacement) pairs")
-- 
2.32.0

[PATCH 2/3] doc: read notmuch-tree.rsti for rst_epilog

[David Bremner]

This is needed so that docstrings from notmuch-tree.el (in particular
notmuch-tree-toggle-order) can be used in the emacs documentation.
---
 doc/conf.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/conf.py b/doc/conf.py
index 4a4a3421..3ec55a61 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -45,7 +45,7 @@ if tags.has('WITH_EMACS'):
     # Hacky reimplementation of include to workaround limitations of
     # sphinx-doc
     lines = ['.. include:: /../emacs/rstdoc.rsti\n\n'] # in the source tree
-    for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-show.rsti', 'notmuch-tag.rsti'):
+    for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-show.rsti', 'notmuch-tag.rsti', 'notmuch-tree.rsti'):
         lines.extend(open(rsti_dir+'/'+file))
     rst_epilog = ''.join(lines)
     del lines
-- 
2.32.0

[PATCH 3/3] doc/emacs: use :code: for some missing references

[David Bremner]

It's not obvious how to reference (non-notmuch) emacs variables and
functions in a sphinx document.
---
 doc/notmuch-emacs.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst
index 36dcb116..12ee25e5 100644
--- a/doc/notmuch-emacs.rst
+++ b/doc/notmuch-emacs.rst
@@ -385,10 +385,10 @@ Sending Mail
 
 :index:`mail-user-agent`
 
-       Emacs consults the variable :ref:`mail-user-agent` to choose a mail
-       sending package for commands like :ref:`report-emacs-bug` and
-       :ref:`compose-mail`.  To use ``notmuch`` for this, customize this
-       variable to the symbol :ref:`notmuch-user-agent`.
+       Emacs consults the variable :code:`mail-user-agent` to choose a mail
+       sending package for commands like :code:`report-emacs-bug` and
+       :code:`compose-mail`.  To use ``notmuch`` for this, customize this
+       variable to the symbol :code:`notmuch-user-agent`.
 
 Init File
 ---------
-- 
2.32.0

Re: [PATCH 1/3] emacs/rstdoc: escape '*'

[Tomi Ollila]

series LGTM.

Tomi

On Sat, Aug 21 2021, David Bremner wrote:

> This is just a regular character in docstrings (as it is fairly often
> used in lisp identifiers and buffer names) but is the start of
> emphasis in rst. This change is needed to quell a noisy warning when
> including notmuch-tree.rsti
> ---
>  emacs/rstdoc.el | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/emacs/rstdoc.el b/emacs/rstdoc.el
> index c7c13015..5b8a9d01 100644
> --- a/emacs/rstdoc.el
> +++ b/emacs/rstdoc.el
> @@ -71,6 +71,7 @@
>       ("`" . "\\\\`")
>       ("\001" . "'")
>       ("\002" . "`")
> +     ("[*]" . "\\\\*")
>       ("^[[:space:]]*$" . "|br|")
>       ("^[[:space:]]" . "|indent| "))
>      "list of (regex . replacement) pairs")
> -- 
> 2.32.0
> _______________________________________________
> notmuch mailing list -- notmuch@notmuchmail.org
> To unsubscribe send an email to notmuch-leave@notmuchmail.org

Re: [PATCH 1/3] emacs/rstdoc: escape '*'

[David Bremner]

David Bremner <david@tethera.net> writes:

> This is just a regular character in docstrings (as it is fairly often
> used in lisp identifiers and buffer names) but is the start of
> emphasis in rst. This change is needed to quell a noisy warning when
> including notmuch-tree.rsti

series applied to master.

d