public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	SeongJae Park <sj38.park@gmail.com>,
	Daniel Vetter <daniel.vetter@ffwll.ch>,
	Markus Heiser <markus.heiser@darmarit.de>
Subject: [PATCH 0/5] Add a script to check for Sphinx install requirements
Date: Sun, 16 Jul 2017 19:08:01 -0300	[thread overview]
Message-ID: <cover.1500241961.git.mchehab@s-opensource.com> (raw)

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

             reply	other threads:[~2017-07-16 22:08 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-07-16 22:08 Mauro Carvalho Chehab [this message]
2017-07-16 22:08 ` [PATCH 1/5] scripts/sphinx-pre-install: add a script to check Sphinx install Mauro Carvalho Chehab
2017-07-16 22:08 ` [PATCH 2/5] sphinx-pre-install: detect an existing virtualenv Mauro Carvalho Chehab
2017-07-16 22:08 ` [PATCH 3/5] sphinx-pre-install: use a requirements file Mauro Carvalho Chehab
2017-07-17  6:00   ` Markus Heiser
2017-07-17  9:36     ` Mauro Carvalho Chehab
2017-07-16 22:08 ` [PATCH 4/5] sphinx.rst: document scripts/sphinx-pre-install script Mauro Carvalho Chehab
2017-07-16 22:08 ` [PATCH 5/5] doc: Makefile: if sphinx is not found, run a check script Mauro Carvalho Chehab
2017-07-17  8:15 ` [PATCH 0/5] Add a script to check for Sphinx install requirements Markus Heiser
2017-07-17  9:33   ` Mauro Carvalho Chehab
2017-07-17 10:09     ` Mauro Carvalho Chehab
2017-07-17 10:32       ` Markus Heiser
2017-07-17 10:57       ` Mauro Carvalho Chehab
2017-07-18  8:53         ` Markus Heiser

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cover.1500241961.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=daniel.vetter@ffwll.ch \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=markus.heiser@darmarit.de \
    --cc=mchehab@infradead.org \
    --cc=sj38.park@gmail.com \
    /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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox