From: David Bremner <david@tethera.net>
To: Jani Nikula <jani@nikula.org>, notmuch@notmuchmail.org
Subject: Re: [RFC PATCH] doc: add support for adding configure options as Sphinx tags
Date: Thu, 09 Mar 2017 08:47:18 -0400 [thread overview]
Message-ID: <878toe62i1.fsf@tethera.net> (raw)
In-Reply-To: <20170226205657.5512-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
>
It does seem like it could potentially help people find what optional
features are available.
A couple of observations
1) Many people read documentation on-line, even in cases where some of
us might not think it makes sense.
2) We might eventually (per an outstanding request) provide a seperate
tarball of prebuilt docs.
Both of those suggest a need to build a "generic" version of the docs.
d
prev parent reply other threads:[~2017-03-09 12:47 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-02-26 20:56 [RFC PATCH] doc: add support for adding configure options as Sphinx tags Jani Nikula
2017-03-09 12:47 ` David Bremner [this message]
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=878toe62i1.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).