From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by arlo.cworth.org (Postfix) with ESMTP id 5815A6DE1C04 for ; Thu, 9 Mar 2017 04:47:22 -0800 (PST) X-Virus-Scanned: Debian amavisd-new at cworth.org X-Spam-Flag: NO X-Spam-Score: -0.005 X-Spam-Level: X-Spam-Status: No, score=-0.005 tagged_above=-999 required=5 tests=[AWL=0.006, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01] autolearn=disabled Received: from arlo.cworth.org ([127.0.0.1]) by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id sRDYHzP92hUK for ; Thu, 9 Mar 2017 04:47:21 -0800 (PST) Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197]) by arlo.cworth.org (Postfix) with ESMTPS id 5EFA56DE1BF8 for ; Thu, 9 Mar 2017 04:47:21 -0800 (PST) Received: from remotemail by fethera.tethera.net with local (Exim 4.84_2) (envelope-from ) id 1clxSp-0001nZ-6F; Thu, 09 Mar 2017 07:46:39 -0500 Received: (nullmailer pid 18437 invoked by uid 1000); Thu, 09 Mar 2017 12:47:18 -0000 From: David Bremner To: Jani Nikula , notmuch@notmuchmail.org Subject: Re: [RFC PATCH] doc: add support for adding configure options as Sphinx tags In-Reply-To: <20170226205657.5512-1-jani@nikula.org> References: <20170226205657.5512-1-jani@nikula.org> Date: Thu, 09 Mar 2017 08:47:18 -0400 Message-ID: <878toe62i1.fsf@tethera.net> MIME-Version: 1.0 Content-Type: text/plain X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 09 Mar 2017 12:47:22 -0000 Jani Nikula 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