From: David Bremner <david@tethera.net>
To: Jani Nikula <jani@nikula.org>, notmuch@notmuchmail.org
Subject: Re: [PATCH] doc: add support for adding configure options as Sphinx tags
Date: Tue, 19 Mar 2019 20:41:33 -0300 [thread overview]
Message-ID: <875zse5t5e.fsf@tethera.net> (raw)
In-Reply-To: <20190319190146.26155-1-jani@nikula.org>
Jani Nikula <jani@nikula.org> writes:
> Add the configure options specified in $(TAGS) that equal 1 as tags on
> the Sphinx command line using the -t option. The tags may be used to
> conditionally include documentation using the Sphinx "only" directive
> [1].
>
> As an example, indicate in the documentation whether the Xapian field
> processor is likely to be available (assuming the notmuch binary was
> built in the same environment as the documentation).
>
> [1] http://www.sphinx-doc.org/en/stable/markup/misc.html#including-content-based-on-tags
>
> ---
>
> This is something I wrote two years ago, ISTR David asking about
> something like this on IRC, but I've already forgotten what it was
> about...
> ---
> doc/Makefile.local | 7 ++++++-
> doc/man7/notmuch-search-terms.rst | 8 ++++++++
> 2 files changed, 14 insertions(+), 1 deletion(-)
>
> diff --git a/doc/Makefile.local b/doc/Makefile.local
> index bab3d0d286ce..95df9ae82b4f 100644
> --- a/doc/Makefile.local
> +++ b/doc/Makefile.local
> @@ -7,8 +7,13 @@ SPHINXOPTS := -q
> SPHINXBUILD = sphinx-build
> DOCBUILDDIR := $(dir)/_build
>
> +# Configure options to be added as Sphinx tags.
> +# Add "-t <tag>" for each make variable in TAGS that equals 1.
> +TAGS := HAVE_XAPIAN_FIELD_PROCESSOR HAVE_XAPIAN_COMPACT
Is there a good reason TAGS not defined in Makefile.config? Or just a
lack of tuits?
d
next prev parent reply other threads:[~2019-03-19 23:41 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-19 19:01 [PATCH] doc: add support for adding configure options as Sphinx tags Jani Nikula
2019-03-19 19:06 ` David Bremner
2019-03-19 23:41 ` David Bremner [this message]
2019-04-25 22:24 ` 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=875zse5t5e.fsf@tethera.net \
--to=david@tethera.net \
--cc=jani@nikula.org \
--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).