Return-Path: <linux-kernel-owner@vger.kernel.org>
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
        id S1751194AbdGOCVu (ORCPT <rfc822;w@1wt.eu>);
        Fri, 14 Jul 2017 22:21:50 -0400
Received: from ec2-52-27-115-49.us-west-2.compute.amazonaws.com ([52.27.115.49]:47829
        "EHLO osg.samsung.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org
        with ESMTP id S1751120AbdGOCVt (ORCPT
        <rfc822;linux-kernel@vger.kernel.org>);
        Fri, 14 Jul 2017 22:21:49 -0400
Date: Fri, 14 Jul 2017 23:21:40 -0300
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Markus Heiser <markus.heiser@darmarit.de>
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>
Subject: Re: [PATCH RFC] scripts/sphinx-pre-install: add a script to check
 Sphinx install
Message-ID: <20170714232140.0608da3c@vento.lan>
In-Reply-To: <042D234A-6B3D-43D4-84BA-8332C0596AA4@darmarit.de>
References: <7ab9f1045ad103f1da56cb6b19948ea107fdb272.1500050599.git.mchehab@s-opensource.com>
 <042D234A-6B3D-43D4-84BA-8332C0596AA4@darmarit.de>
Organization: Samsung
X-Mailer: Claws Mail 3.14.1 (GTK+ 2.24.31; x86_64-redhat-linux-gnu)
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
Content-Length: 1894
Lines: 61

Em Fri, 14 Jul 2017 19:35:59 +0200
Markus Heiser <markus.heiser@darmarit.de> escreveu:

> > 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.


The above assumes that the user wants to use virtenv and
have python3, virtualenv3 and pip3 already installed.

I agree that a virtual environment works better than using
distro-specific packaging, as Sphinx toolchain is really
fragile. But we should give an option for the developer to
use whatever he wants.

I'm actually thinking that the final version of this script
is to have a command line parameter to would allow selecting
between virtenv or package install for Sphinx.

IMHO, virtenv should be the default.

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

Your proposal doesn't solve Python, TeX, GraphViz nor 
ImageMagick dependencies.

The TeX dependencies are the hardest ones, and, whatever
solution we take, this should be taken into account.

Thanks,
Mauro