docs: update requirements to install six module
Subsystems (2)
PATCH 1/1 docs: update requirements to install six module
On the update of Sphinx version to 2.4.4, the "six" library won't be installed automatically. (which is required by kfigure.py)
Main reason of this issue were occurred by the requirements changed from the sphinx library. In Sphinx v1.7.9, six was listed on the install_requires, but it has been removed since 2.x
The kfigure.py uses six library explicitly, adding six to requirements.txt seems reasonable
--- Documentation/sphinx/requirements.txt | 1 + 1 file changed, 1 insertion(+)
Documentation/sphinx/requirements.txt +1 -0
@@ -1,3 +1,4 @@ docutils Sphinx==2.4.4 sphinx_rtd_theme +six
Signature · 1 line
2.25.1
Em Tue, 8 Dec 2020 10:46:28 +0900
JaeSang Yoo <[email protected]> escreveu:
Quoted 11 lines
On the update of Sphinx version to 2.4.4, the "six" library won't be installed automatically. (which is required by
kfigure.py)Main reason of this issue were occurred by the requirements changed from the sphinx library. In Sphinx v1.7.9, six was listed on the
install_requires, but it has been removed since 2.xThe
kfigure.pyuses six library explicitly, adding six to requirements.txt seems reasonableSigned-off-by JaeSang Yoo <[email protected]>
Documentation/sphinx/requirements.txt line 4
Quoted 13 lines
--- Documentation/sphinx/requirements.txt | 1 + 1 file changed, 1 insertion(+)Documentation/sphinx/requirements.txt +1
-0@@ -1,3 +1,4 @@ docutils Sphinx==2.4.4 sphinx_rtd_theme +six
Thanks,
Mauro
Jonathan Corbet
maintainerQuoted 20 lines · On Tue, 8 Dec 2020 10:46:28 +0900 JaeSang Yoo <[email protected]> wrote:
On the update of Sphinx version to 2.4.4, the "six" library won't be installed automatically. (which is required by
kfigure.py)Main reason of this issue were occurred by the requirements changed from the sphinx library. In Sphinx v1.7.9, six was listed on the
install_requires, but it has been removed since 2.xThe
kfigure.pyuses six library explicitly, adding six to requirements.txt seems reasonableSigned-off-by JaeSang Yoo <[email protected]>--- Documentation/sphinx/requirements.txt | 1 + 1 file changed, 1 insertion(+)Documentation/sphinx/requirements.txt +0
-0
Documentation/sphinx/requirements.txt line 4
Quoted 4 lines
Documentation/sphinx/requirements.txt +1
-0@@ -1,3 +1,4 @@ docutils Sphinx==2.4.4 sphinx_rtd_theme +six
Sigh...what we really need to do is to leave Python 2 behind. Until then, though, we need to install "six". Patch applied, thanks.
jon
Quoted 19 lines · Jonathan Corbet
Quoted 15 lines · On Tue, 8 Dec 2020 10:46:28 +0900 JaeSang Yoo <[email protected]> wrote:
On the update of Sphinx version to 2.4.4, the "six" library won't be installed automatically. (which is required by
kfigure.py)Main reason of this issue were occurred by the requirements changed from the sphinx library. In Sphinx v1.7.9, six was listed on the
install_requires, but it has been removed since 2.xThe
kfigure.pyuses six library explicitly, adding six to requirements.txt seems reasonableSigned-off-by JaeSang Yoo <[email protected]>--- Documentation/sphinx/requirements.txt | 1 + 1 file changed, 1 insertion(+)
Quoted 12 lines
Documentation/sphinx/requirements.txt line 4
Quoted 9 lines
Documentation/sphinx/requirements.txt +1
-0@@ -1,3 +1,4 @@ docutils Sphinx==2.4.4 sphinx_rtd_theme +sixSigh...what we really need to do is to leave Python 2 behind. Until then, though, we need to install "six". Patch applied, thanks.
While I was surveying the Sphinx library, it requires Python version 3.5 as a minimum.
You can figure it out in the setup.py of Sphinx library source:
https://github.com/sphinx-doc/sphinx/blob/72ad5f2a/setup.py#L13-L15
I assume this would be a certain reason to leave Python 2 behind. The Sphinx check script recommends using virtualenv. How do you think about leaving Python 2 compatibility issue in this documentation script range?
Quoted 1 line
jon
Jonathan Corbet
maintainerQuoted 4 lines · On Thu, 10 Dec 2020 12:39:42 +0900 JaeSang Yoo <[email protected]> wrote:
While I was surveying the Sphinx library, it requires Python version 3.5 as a minimum.
You can figure it out in thesetup.pyof Sphinx library source:
https://github.com/sphinx-doc/sphinx/blob/72ad5f2a/setup.py#L13-L15
That, of course, applies to current Sphinx releases. We have people building with older releases, though, which still work with Python 2.
Quoted 4 lines
I assume this would be a certain reason to leave Python 2 behind. The Sphinx check script recommends using virtualenv. How do you think about leaving Python 2 compatibility issue in this documentation script range?
I'm sorry, I don't quite understand your question.
Thanks,
jon
Quoted 4 lines · Jonathan Corbet
On Thu, 10 Dec 2020 12:39:42 +0900
JaeSang Yoo <[email protected]> wrote:
Quoted 8 lines
Quoted 4 lines
While I was surveying the Sphinx library, it requires Python version 3.5 as a minimum.
You can figure it out in thesetup.pyof Sphinx library source:
https://github.com/sphinx-doc/sphinx/blob/72ad5f2a/setup.py#L13-L15That, of course, applies to current Sphinx releases. We have people building with older releases, though, which still work with Python 2.
Is this meaning that some people are using older Sphinx? Then, there's no chance to leave from Python2.
By the way, the previous linked commit ID is tagged as v2.4.4 which is selected in requirements.txt
Quoted 6 lines
Quoted 4 lines
I assume this would be a certain reason to leave Python 2 behind. The Sphinx check script recommends using virtualenv. How do you think about leaving Python 2 compatibility issue in this documentation script range?
I'm sorry, I don't quite understand your question.
Sorry for my poor English writings.
I thought most users are using virtualenv. As you know that virtualenv will help using the specific version of Python libraries and the Python interpreter's version.
I'll try to describe what I tried to say.
1. The Sphinx check script recommends using virtualenv for preparing Sphinx document generation environment.
2. By the virtualenv, we can isolate the Python libraries and the interpreter's version.
(for the Sphinx documentation build)
3. When all the people are using the virtualenv, It will install Sphinx v2.4.4, which doesn't support Python2.
4. The Sphinx installation will fail for Python2 users.
And it could lead to "no need to consider Python2 compatibility"
But as you told me above, Step 3 seems false. Still, we need to consider Python2.
Thanks,
JaeSang
Jonathan Corbet
maintainerQuoted 2 lines · On Fri, 11 Dec 2020 10:15:36 +0900 JaeSang Yoo <[email protected]> wrote:
Is this meaning that some people are using older Sphinx? Then, there's no chance to leave from Python2.
We still support Sphinx back to 1.3, though that's pushing forward to 1.7 shortly. The virtualenv approach is recommended as a way to get a relatively predictable setup, but we don't force it on people.
And yes, decisions to drop Python 2 support and support for older Sphinx versions kind of go together.
Thanks,
jon