Messages in this thread | | | From | Mauro Carvalho Chehab <> | Subject | [PATCH 0/5] Add a script to check for Sphinx install requirements | Date | Sun, 16 Jul 2017 19:08:01 -0300 |
| |
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
| |