Return-Path: <linux-kernel-owner@vger.kernel.org>
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
        id S1754789AbdGNRgu convert rfc822-to-8bit (ORCPT <rfc822;w@1wt.eu>);
        Fri, 14 Jul 2017 13:36:50 -0400
Received: from smtp2.goneo.de ([85.220.129.33]:34596 "EHLO smtp2.goneo.de"
        rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP
        id S1754698AbdGNRgr (ORCPT <rfc822;linux-kernel@vger.kernel.org>);
        Fri, 14 Jul 2017 13:36:47 -0400
X-Spam-Flag: NO
X-Spam-Score: -2.866
Content-Type: text/plain; charset=us-ascii
Mime-Version: 1.0 (Mac OS X Mail 10.3 \(3273\))
Subject: Re: [PATCH RFC] scripts/sphinx-pre-install: add a script to check
 Sphinx install
From: Markus Heiser <markus.heiser@darmarit.de>
In-Reply-To: <7ab9f1045ad103f1da56cb6b19948ea107fdb272.1500050599.git.mchehab@s-opensource.com>
Date: Fri, 14 Jul 2017 19:35:59 +0200
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
        Mauro Carvalho Chehab <mchehab@infradead.org>,
        linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Content-Transfer-Encoding: 8BIT
Message-Id: <042D234A-6B3D-43D4-84BA-8332C0596AA4@darmarit.de>
References: <7ab9f1045ad103f1da56cb6b19948ea107fdb272.1500050599.git.mchehab@s-opensource.com>
To: Mauro Carvalho Chehab <mchehab@s-opensource.com>
X-Mailer: Apple Mail (2.3273)
Sender: linux-kernel-owner@vger.kernel.org
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
Content-Length: 1028
Lines: 38


> Am 14.07.2017 um 18:49 schrieb Mauro Carvalho Chehab <mchehab@s-opensource.com>:
> 
> Solving Sphinx dependencies can be painful. Add a script to
> check if everything is ok.

just my 5cent:

What we need is a "requirements.txt" file to define a
**reference environment**. E.g. to stick Sphinx 1.4.9 in
such a reference environment::

<snip: requirements.txt> ---
Sphinx==1.4.9
sphinx_rtd_theme
<snap> ---------------------

The rest is similarly to what you wrote in doc-guide/sphinx.rst ...

The ref-environment can be build with virtualenv & pip::

$ virtualenv --python=python3 docenv
(doc-env) $ source ./docenv/bin/activate
(doc-env) $ pip install -r requirements.txt

>From now we can start our build as usual. If not already done,
first activate the environment::

$ . ./docenv/bin/activate
(doc-env) $ make htmldocs

This (requirements.txt) is the way python packaging goes.

Ok, this won't solve TeX installation problems of Linux distros,
for this a script like the one here in your RFC is helpful.

-- Markus --