diff options
| author | Quentin Schulz <foss@0leil.net> | 2020-10-04 15:12:40 +0200 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-01-04 10:55:01 +0000 |
| commit | 4030fd0f3c3439695949f09b6378278bdd9569bf (patch) | |
| tree | 8471fca62c1d49263e658173ab523a624590ebc0 /documentation | |
| parent | ccb3a1db7643b1aca9eed75faead6608c827667d (diff) | |
| download | poky-4030fd0f3c3439695949f09b6378278bdd9569bf.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: db2e97515636674a0b04d2fe3f35b433b49b6c0f)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(cherry picked from commit 14da565986a573ac7e0b5c5943e55b7b74f99dd5)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
| -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 6c8727e450..74b5481ae4 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 c5d2c2a699..65234d0722 100644 --- a/documentation/ref-manual/ref-system-requirements.rst +++ b/documentation/ref-manual/ref-system-requirements.rst | |||
| @@ -145,7 +145,14 @@ supported Ubuntu or Debian Linux distribution: | |||
| 145 | Yocto Project documentation manuals: | 145 | Yocto Project documentation manuals: |
| 146 | :: | 146 | :: |
| 147 | 147 | ||
| 148 | $ sudo apt-get install make xsltproc docbook-utils fop dblatex xmlto | 148 | $ sudo apt-get install make python3-pip |
| 149 | &PIP3_HOST_PACKAGES_DOC; | ||
| 150 | |||
| 151 | .. note:: | ||
| 152 | |||
| 153 | It is currently not possible to build out documentation from Debian 8 | ||
| 154 | (Jessie) because of outdated ``pip3`` and ``python3``. ``python3-sphinx`` | ||
| 155 | is too outdated. | ||
| 149 | 156 | ||
| 150 | Fedora Packages | 157 | Fedora Packages |
| 151 | --------------- | 158 | --------------- |
| @@ -163,8 +170,8 @@ supported Fedora Linux distribution: | |||
| 163 | Yocto Project documentation manuals: | 170 | Yocto Project documentation manuals: |
| 164 | :: | 171 | :: |
| 165 | 172 | ||
| 166 | $ sudo dnf install docbook-style-dsssl docbook-style-xsl \ | 173 | $ sudo dnf install make python3-pip which |
| 167 | docbook-dtds docbook-utils fop libxslt dblatex xmlto | 174 | &PIP3_HOST_PACKAGES_DOC; |
| 168 | 175 | ||
| 169 | openSUSE Packages | 176 | openSUSE Packages |
| 170 | ----------------- | 177 | ----------------- |
| @@ -182,7 +189,8 @@ supported openSUSE Linux distribution: | |||
| 182 | Yocto Project documentation manuals: | 189 | Yocto Project documentation manuals: |
| 183 | :: | 190 | :: |
| 184 | 191 | ||
| 185 | $ sudo zypper install dblatex xmlto | 192 | $ sudo zypper install make python3-pip which |
| 193 | &PIP3_HOST_PACKAGES_DOC; | ||
| 186 | 194 | ||
| 187 | 195 | ||
| 188 | CentOS-7 Packages | 196 | CentOS-7 Packages |
| @@ -211,8 +219,8 @@ supported CentOS-7 Linux distribution: | |||
| 211 | Yocto Project documentation manuals: | 219 | Yocto Project documentation manuals: |
| 212 | :: | 220 | :: |
| 213 | 221 | ||
| 214 | $ sudo yum install docbook-style-dsssl docbook-style-xsl \ | 222 | $ sudo yum install make python3-pip which |
| 215 | docbook-dtds docbook-utils fop libxslt dblatex xmlto | 223 | &PIP3_HOST_PACKAGES_DOC; |
| 216 | 224 | ||
| 217 | CentOS-8 Packages | 225 | CentOS-8 Packages |
| 218 | ----------------- | 226 | ----------------- |
| @@ -243,8 +251,8 @@ supported CentOS-8 Linux distribution: | |||
| 243 | Yocto Project documentation manuals: | 251 | Yocto Project documentation manuals: |
| 244 | :: | 252 | :: |
| 245 | 253 | ||
| 246 | $ sudo dnf install docbook-style-dsssl docbook-style-xsl \ | 254 | $ sudo dnf install make python3-pip which |
| 247 | docbook-dtds docbook-utils fop libxslt dblatex xmlto | 255 | &PIP3_HOST_PACKAGES_DOC; |
| 248 | 256 | ||
| 249 | Required Git, tar, Python and gcc Versions | 257 | Required Git, tar, Python and gcc Versions |
| 250 | ========================================== | 258 | ========================================== |
