diff options
author | Quentin Schulz <foss@0leil.net> | 2020-10-04 15:12:40 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-10-20 11:12:06 +0100 |
commit | c04e9aa806d6d10d958e07e83aa23a505244eb71 (patch) | |
tree | 7df5696067d099cb1317b3d59e7c4aeb831687f3 | |
parent | 5ab3c28b03e6571babaa7dd3dce4c2a2c613074a (diff) | |
download | poky-c04e9aa806d6d10d958e07e83aa23a505244eb71.tar.gz |
docs: ref-manual: ref-system-requirements: update requirements to build Sphinx docs
Tested with containers on all supported distributions.
Debian 8 (Jessie) still has Python3.4 and an old pip3, which makes it
impossible to build typing module which is a requirement of "new" Sphinx
python module.
One cannot update to latest pip3 from within pip in Jessie's version.
One cannot get a newer pip from upstream because newer pip don't support
Python3.4 anymore.
One cannot build with python3-sphinx package from Jessie because the
package is too old (1.2.3) and does not have sphinx.ext.autosectionlabel
module which appeared in 1.4 version.
(From yocto-docs rev: 14da565986a573ac7e0b5c5943e55b7b74f99dd5)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/poky.yaml | 1 | ||||
-rw-r--r-- | documentation/ref-manual/ref-system-requirements.rst | 24 |
2 files changed, 17 insertions, 8 deletions
diff --git a/documentation/poky.yaml b/documentation/poky.yaml index 14f45055d7..d50b8321a3 100644 --- a/documentation/poky.yaml +++ b/documentation/poky.yaml | |||
@@ -86,3 +86,4 @@ CENTOS8_HOST_PACKAGES_ESSENTIAL : "-y epel-release | |||
86 | socat perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip \ | 86 | socat perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip \ |
87 | python3-GitPython python3-jinja2 python3-pexpect xz which SDL-devel xterm \ | 87 | python3-GitPython python3-jinja2 python3-pexpect xz which SDL-devel xterm \ |
88 | rpcgen mesa-libGL-devel" | 88 | rpcgen mesa-libGL-devel" |
89 | PIP3_HOST_PACKAGES_DOC : "$ sudo pip3 install sphinx sphinx_rtd_theme pyyaml" | ||
diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst index 403b486b34..fe7c9252ca 100644 --- a/documentation/ref-manual/ref-system-requirements.rst +++ b/documentation/ref-manual/ref-system-requirements.rst | |||
@@ -141,7 +141,14 @@ supported Ubuntu or Debian Linux distribution: | |||
141 | Yocto Project documentation manuals: | 141 | Yocto Project documentation manuals: |
142 | :: | 142 | :: |
143 | 143 | ||
144 | $ sudo apt-get install make xsltproc docbook-utils fop dblatex xmlto | 144 | $ sudo apt-get install make python3-pip |
145 | &PIP3_HOST_PACKAGES_DOC; | ||
146 | |||
147 | .. note:: | ||
148 | |||
149 | It is currently not possible to build out documentation from Debian 8 | ||
150 | (Jessie) because of outdated ``pip3`` and ``python3``. ``python3-sphinx`` | ||
151 | is too outdated. | ||
145 | 152 | ||
146 | Fedora Packages | 153 | Fedora Packages |
147 | --------------- | 154 | --------------- |
@@ -159,8 +166,8 @@ supported Fedora Linux distribution: | |||
159 | Yocto Project documentation manuals: | 166 | Yocto Project documentation manuals: |
160 | :: | 167 | :: |
161 | 168 | ||
162 | $ sudo dnf install docbook-style-dsssl docbook-style-xsl \ | 169 | $ sudo dnf install make python3-pip which |
163 | docbook-dtds docbook-utils fop libxslt dblatex xmlto | 170 | &PIP3_HOST_PACKAGES_DOC; |
164 | 171 | ||
165 | openSUSE Packages | 172 | openSUSE Packages |
166 | ----------------- | 173 | ----------------- |
@@ -178,7 +185,8 @@ supported openSUSE Linux distribution: | |||
178 | Yocto Project documentation manuals: | 185 | Yocto Project documentation manuals: |
179 | :: | 186 | :: |
180 | 187 | ||
181 | $ sudo zypper install dblatex xmlto | 188 | $ sudo zypper install make python3-pip which |
189 | &PIP3_HOST_PACKAGES_DOC; | ||
182 | 190 | ||
183 | 191 | ||
184 | CentOS-7 Packages | 192 | CentOS-7 Packages |
@@ -207,8 +215,8 @@ supported CentOS-7 Linux distribution: | |||
207 | Yocto Project documentation manuals: | 215 | Yocto Project documentation manuals: |
208 | :: | 216 | :: |
209 | 217 | ||
210 | $ sudo yum install docbook-style-dsssl docbook-style-xsl \ | 218 | $ sudo yum install make python3-pip which |
211 | docbook-dtds docbook-utils fop libxslt dblatex xmlto | 219 | &PIP3_HOST_PACKAGES_DOC; |
212 | 220 | ||
213 | CentOS-8 Packages | 221 | CentOS-8 Packages |
214 | ----------------- | 222 | ----------------- |
@@ -239,8 +247,8 @@ supported CentOS-8 Linux distribution: | |||
239 | Yocto Project documentation manuals: | 247 | Yocto Project documentation manuals: |
240 | :: | 248 | :: |
241 | 249 | ||
242 | $ sudo dnf install docbook-style-dsssl docbook-style-xsl \ | 250 | $ sudo dnf install make python3-pip which |
243 | docbook-dtds docbook-utils fop libxslt dblatex xmlto | 251 | &PIP3_HOST_PACKAGES_DOC; |
244 | 252 | ||
245 | Required Git, tar, Python and gcc Versions | 253 | Required Git, tar, Python and gcc Versions |
246 | ========================================== | 254 | ========================================== |