Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
From:   "Bird, Tim" <Tim.Bird@sony.com>
To:     "linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
        "corbet@lwn.net" <corbet@lwn.net>,
        "mchehab@kernel.org" <mchehab@kernel.org>
CC:     LKML <linux-kernel@vger.kernel.org>
Subject: RFC: Fix for sphinx setup message
Thread-Topic: RFC: Fix for sphinx setup message
Thread-Index: AdXpBDdLywF8zW5LQ+SWSa0xf1943Q==
Date:   Fri, 21 Feb 2020 22:15:36 +0000
Message-ID: <MWHPR13MB0895675B302AF38BB1D141BBFD120@MWHPR13MB0895.namprd13.prod.outlook.com>
Accept-Language: en-US
Content-Language: en-US
received-spf: None (protection.outlook.com: sony.com does not designate
 permitted sender hosts)
Content-Type: text/plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-Network-Message-Id: d8435d89-fbf7-4ff1-586e-08d7b71b9405
X-MS-Exchange-CrossTenant-originalarrivaltime: 21 Feb 2020 22:15:36.9663
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 66c65d8a-9158-4521-a2d8-664963db48e4
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: MYxh3ImlHzLLVAMtUqrbs+Sqq+k39fWSFsB7VdcuYar2363jV+v/HUAbhdQ9+v3teylNDIW1woIq/WI2oHwMvg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MWHPR13MB1392
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

(Resend: Sorry for the dup.  I forgot to include the maintainers, and I had=
 the LKML
address wrong.)=20

I was trying to set up my machine to do some documentation work,=20
and I had some problems with the sphinx install.  I figured out how to work
around the issue, but I have a question about how to add the information
to scripts/sphinx-pre-install (or whether it should go somewhere else).

Detailed messages below, but the TLl;DR is that I got the message:
-------
You should run:

    sudo apt-get install dvipng fonts-noto-cjk latexmk librsvg2-bin texlive=
-xetex
    /usr/bin/virtualenv sphinx_1.7.9
    . sphinx_1.7.9/bin/activate
    pip install -r ./Documentation/sphinx/requirements.txt
    ...
------

The pip install step didn't work, and I found that I needed to have everyth=
ing
based on python3 instead.  When I replaced:
    /usr/bin/virtualenv sphinx_1.7.9
with
    /usr/bin/virtualenv -p python3 sphinx_1.7.9
everything worked.

This message is coming from scripts/sphinx-pre-install (I believe on line 7=
08).

Should I go ahead and submit a patch to add '-p python3' to that line?

Are there any downsides to enforcing that the virtualenv used for the
documentation build use python3 only?

Thanks,
 -- Tim

Gory details:
I'm running on a machine with Ubuntu 16.04, and I have both python2 and
python3 installed (with /usr/bin/python linked to python2.7).

When I tried to do:
$ make htmldocs
I got the following messages:
...
You should run:

    sudo apt-get install dvipng fonts-noto-cjk latexmk librsvg2-bin texlive=
-xetex
  =20
    /usr/bin/virtualenv sphinx_1.7.9
    . sphinx_1.7.9/bin/activate
    pip install -r ./Documentation/sphinx/requirements.txt
    If you want to exit the virtualenv, you can use:
    deactivate
---=20
Following these instructions, at the 'pip install' step, I got:
$ pip install -r ./Documentation/sphinx/requirements.txt=20
DEPRECATION: Python 2.7 reached the end of its life on January 1st, 2020. P=
lease upgrade your Python as Python 2.7 is no longer maintained. A future v=
ersion of pip will drop support for Python 2.7. More details about Python 2=
 support in pip, can be found at https://pip.pypa.io/en/latest/development/=
release-process/#python-2-support
Collecting docutils
  Downloading docutils-0.16-py2.py3-none-any.whl (548 kB)
     |=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-=
^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-=
^=E2-^=E2-^=E2-^| 548 kB 2.2 MB/s=20
Collecting Sphinx=3D=3D1.7.9
  Downloading Sphinx-1.7.9-py2.py3-none-any.whl (1.9 MB)
     |=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-=
^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-=
^=E2-^=E2-^=E2-^| 1.9 MB 30.7 MB/s=20
Collecting sphinx_rtd_theme
  Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB)
     |=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-=
^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-=
^=E2-^=E2-^=E2-^| 6.4 MB 25.6 MB/s=20
Collecting alabaster<0.8,>=3D0.7
  Downloading alabaster-0.7.12-py2.py3-none-any.whl (14 kB)
Collecting Pygments>=3D2.0
  Downloading Pygments-2.5.2-py2.py3-none-any.whl (896 kB)
     |=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-=
^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-=
^=E2-^=E2-^=E2-^| 896 kB 35.1 MB/s=20
Collecting Jinja2>=3D2.3
  Downloading Jinja2-2.11.1-py2.py3-none-any.whl (126 kB)
     |=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-=
^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-=
^=E2-^=E2-^=E2-^| 126 kB 26.2 MB/s=20
Collecting requests>=3D2.0.0
  Downloading requests-2.23.0-py2.py3-none-any.whl (58 kB)
     |=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-=
^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-=
^=E2-^=E2-^=E2-^| 58 kB 774 kB/s=20
Collecting packaging
  Downloading packaging-20.1-py2.py3-none-any.whl (36 kB)
Collecting snowballstemmer>=3D1.1
  Downloading snowballstemmer-2.0.0-py2.py3-none-any.whl (97 kB)
     |=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-=
^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-^=E2-=
^=E2-^=E2-^=E2-^| 97 kB 1.1 MB/s=20
Collecting sphinxcontrib-websupport
  Downloading sphinxcontrib_websupport-1.1.2-py2.py3-none-any.whl (39 kB)
Requirement already satisfied: setuptools in ./sphinx_1.7.9/lib/python2.7/s=
ite-packages (from Sphinx=3D=3D1.7.9->-r ./Documentation/sphinx/requirement=
s.txt (line 2)) (45.0.0)
ERROR: Package 'setuptools' requires a different Python: 2.7.12 not in '>=
=3D3.5'