All of lore.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>
Subject: [PATCH v2 0/8] Add a script to check for Sphinx install requirements
Date: Mon, 17 Jul 2017 18:46:34 -0300	[thread overview]
Message-ID: <cover.1500327282.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 :-)

Those patches are at:

   https://git.linuxtv.org/mchehab/experimental.git/log/?h=sphinx_install_v2



PS.:

1) The first patch in this series is actually independent: it
   is just a cleanup from DocBook removal patches.

2) Debian 17.04 version of ImageMagick seems capped:
   it can't read SVG texts with things like:
	font-family="'Liberation Sans', Sans"
   It also doesn't handle other random SVG tags.
   So, I had to rewrite several media SVG files to make
   them more compliant with ImageMagick.

   So far, I can't submit those patches via e-mail, as some
   lines there are bigger than 998 characters, with violates
   VGER rules for maximum number of columns. I'll try
   to break the big lines there via some scripting.

-

v2: be sure that GraphViz and ImageMagick will generate PDF
    outputs on all platforms but OpenSuse (where GraphViz
    is built without PDf support).


Mauro Carvalho Chehab (8):
  docs: Makefile: remove no-ops targets
  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-pre-install: check for the need of graphviz-gd
  sphinx-pre-install: add dependencies for ImageMagick to work with svg
  sphinx-pre-install: fix USE needs for GraphViz and ImageMagick
  sphinx.rst: document scripts/sphinx-pre-install script

 Documentation/Makefile                 |  10 -
 Documentation/doc-guide/sphinx.rst     |  48 ++-
 Documentation/sphinx/requirements.txt  |   3 +
 Documentation/translations/zh_CN/HOWTO |   2 -
 Makefile                               |   2 +-
 scripts/sphinx-pre-install             | 544 +++++++++++++++++++++++++++++++++
 6 files changed, 592 insertions(+), 17 deletions(-)
 create mode 100644 Documentation/sphinx/requirements.txt
 create mode 100755 scripts/sphinx-pre-install

-- 
2.13.3

             reply	other threads:[~2017-07-17 21:48 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-07-17 21:46 Mauro Carvalho Chehab [this message]
2017-07-17 21:46 ` [PATCH v2 1/8] docs: Makefile: remove no-ops targets Mauro Carvalho Chehab
2017-07-17 21:46 ` [PATCH v2 2/8] scripts/sphinx-pre-install: add a script to check Sphinx install Mauro Carvalho Chehab
2017-07-17 21:46 ` [PATCH v2 3/8] sphinx-pre-install: detect an existing virtualenv Mauro Carvalho Chehab
2017-07-17 21:46 ` [PATCH v2 4/8] sphinx-pre-install: use a requirements file Mauro Carvalho Chehab
2017-07-17 21:46 ` [PATCH v2 5/8] sphinx-pre-install: check for the need of graphviz-gd Mauro Carvalho Chehab
2017-07-17 21:46 ` [PATCH v2 6/8] sphinx-pre-install: add dependencies for ImageMagick to work with svg Mauro Carvalho Chehab
2017-07-17 21:46 ` [PATCH v2 7/8] sphinx-pre-install: fix USE needs for GraphViz and ImageMagick Mauro Carvalho Chehab
2017-07-17 21:46 ` [PATCH v2 8/8] sphinx.rst: document scripts/sphinx-pre-install script Mauro Carvalho Chehab
2017-07-23 22:08 ` [PATCH v2 0/8] Add a script to check for Sphinx install requirements Jonathan Corbet
2017-07-23 23:01   ` Mauro Carvalho Chehab
2017-07-24 12:11     ` Mauro Carvalho Chehab

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.1500327282.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@infradead.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.