From: Markus Heiser <markus.heiser@darmarit.de>
To: Mauro Carvalho Chehab <mchehab@s-opensource.com>
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
Date: Fri, 14 Jul 2017 19:35:59 +0200 [thread overview]
Message-ID: <042D234A-6B3D-43D4-84BA-8332C0596AA4@darmarit.de> (raw)
In-Reply-To: <7ab9f1045ad103f1da56cb6b19948ea107fdb272.1500050599.git.mchehab@s-opensource.com>
> 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.
Ok, this won't solve TeX installation problems of Linux distros,
for this a script like the one here in your RFC is helpful.
-- Markus --
next prev parent reply other threads:[~2017-07-14 17:36 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-07-14 16:49 [PATCH RFC] scripts/sphinx-pre-install: add a script to check Sphinx install Mauro Carvalho Chehab
2017-07-14 17:35 ` Markus Heiser [this message]
2017-07-14 22:51 ` Jim Davis
2017-07-15 1:27 ` Mauro Carvalho Chehab
2017-07-15 2:21 ` Mauro Carvalho Chehab
2017-07-15 9:51 ` Markus Heiser
2017-07-15 12:49 ` Mauro Carvalho Chehab
2017-07-15 12:55 ` Mauro Carvalho Chehab
2017-07-15 19:27 ` Mauro Carvalho Chehab
2017-07-16 7:29 ` Markus Heiser
2017-07-16 9:57 ` 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=042D234A-6B3D-43D4-84BA-8332C0596AA4@darmarit.de \
--to=markus.heiser@darmarit.de \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@infradead.org \
--cc=mchehab@s-opensource.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 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.