diff options
| author | David Bremner <david@tethera.net> | 2020-05-31 13:15:03 -0300 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2020-06-01 09:07:50 -0300 |
| commit | ee8dba1c3013a00c0d1185583ea084f8ce3699b7 (patch) | |
| tree | 2c54906711a63e16845a34b02cb27cb191b517d0 /doc/notmuch-emacs.rst | |
| parent | 16d073ebe8fe062bb733165bdb10d7d2937616b5 (diff) | |
doc: fix for out-of-tree builds of notmuch-emacs docs
The sphinx-doc include directive does not have the ability to include
files from the build tree, so we replace the include with reading the
files in conf.py. The non-trivial downside of this is that the emacs
docstrings are now defined for every rst source file. They are
namespaced with docstring::, so hopefully there will not be any
surprises. One thing that is noticable is a small (absolute) time
penalty in running sphinx-doc.
Diffstat (limited to 'doc/notmuch-emacs.rst')
| -rw-r--r-- | doc/notmuch-emacs.rst | 10 |
1 files changed, 0 insertions, 10 deletions
diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst index 1655e2f0..de47b726 100644 --- a/doc/notmuch-emacs.rst +++ b/doc/notmuch-emacs.rst @@ -377,13 +377,3 @@ suffix exist it will be read instead (just one of these, chosen in this order). Most often users create ``~/.emacs.d/notmuch-config.el`` and just work with it. If Emacs was invoked with the ``-q`` or ``--no-init-file`` options, ``notmuch-init-file`` is not read. - -.. include:: ../emacs/rstdoc.rsti - -.. include:: ../emacs/notmuch.rsti - -.. include:: ../emacs/notmuch-lib.rsti - -.. include:: ../emacs/notmuch-show.rsti - -.. include:: ../emacs/notmuch-tag.rsti |