Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751309AbdGPWIT (ORCPT ); Sun, 16 Jul 2017 18:08:19 -0400 Received: from ec2-52-27-115-49.us-west-2.compute.amazonaws.com ([52.27.115.49]:50723 "EHLO osg.samsung.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1751117AbdGPWIN (ORCPT ); Sun, 16 Jul 2017 18:08:13 -0400 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , SeongJae Park , Daniel Vetter , Markus Heiser Subject: [PATCH 0/5] Add a script to check for Sphinx install requirements Date: Sun, 16 Jul 2017 19:08:01 -0300 Message-Id: X-Mailer: git-send-email 2.13.3 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1624 Lines: 42 Sphinx installation is not trivial, as not all versions are supported, and it requires a lot of stuff for math, images and PDF/LaTeX output to work. So, add a script that checks if everything is fine, providing distro-specific hints about what's needed for it to work. I posted already RFC patches for the first patch in this series along this weekend at linux-doc ML. The current version of the script will provide hints for some popular distributions. I tested myself on a couple of release-based and rolling popular distributions: - Fedora 25 and 26; - Ubuntu 17.04; - OpenSuse Tumbleweed; - Arch Linux; - Gentoo. I tested compilation with both htmldocs and pdfdocs targets[1]. Yet, tests (and fix patches) are welcomed :-) [1] There's an unrelated bug with the Kernel's sphinx extension kimage: when parsing GraphViz graphs, it uses "-Tpdf" argument, in order to generate a PDF image. That doesn't work on some distros, as GraphViz doesn't support PDF images. Mauro Carvalho Chehab (5): scripts/sphinx-pre-install: add a script to check Sphinx install sphinx-pre-install: detect an existing virtualenv sphinx-pre-install: use a requirements file sphinx.rst: document scripts/sphinx-pre-install script doc: Makefile: if sphinx is not found, run a check script Documentation/Makefile | 2 + Documentation/doc-guide/sphinx.rst | 48 +++- scripts/sphinx-pre-install | 524 +++++++++++++++++++++++++++++++++++++ 3 files changed, 570 insertions(+), 4 deletions(-) create mode 100755 scripts/sphinx-pre-install -- 2.13.3