mirror of
git://git.yoctoproject.org/poky.git
synced 2025-07-19 21:09:03 +02:00
9bd69b1f1d
This commit is autogenerated pandoc to generate an inital set
of reST files based on DocBook XML files.
A .rst file is generated for each .xml files in all manuals with this
command:
cd <manual>
for i in *.xml; do \
pandoc -f docbook -t rst --shift-heading-level-by=-1 \
$i -o $(basename $i .xml).rst \
done
The conversion was done with: pandoc 2.9.2.1-91 (Arch Linux).
Also created an initial top level index file for each document, and
added all 'books' to the top leve index.rst file.
The YP manuals layout is organized as:
Book
Chapter
Section
Section
Section
Sphinx uses section headers to create the document structure.
ReStructuredText defines sections headers like that:
To break longer text up into sections, you use section headers. These
are a single line of text (one or more words) with adornment: an
underline alone, or an underline and an overline together, in dashes
"-----", equals "======", tildes "~~~~~~" or any of the
non-alphanumeric characters = - ` : ' " ~ ^ _ * + # < > that you feel
comfortable with. An underline-only adornment is distinct from an
overline-and-underline adornment using the same character. The
underline/overline must be at least as long as the title text. Be
consistent, since all sections marked with the same adornment style
are deemed to be at the same level:
Let's define the following convention when converting from Docbook:
Book => overline === (Title)
Chapter => overline *** (1.)
Section => ==== (1.1)
Section => ---- (1.1.1)
Section => ~~~~ (1.1.1.1)
Section => ^^^^ (1.1.1.1.1)
During the conversion with pandoc, we used --shift-heading-level=-1 to
convert most of DocBook headings automatically. However with this
setting, the Chapter header was removed, so I added it back
manually. Without this setting all headings were off by one, which was
more difficult to manually fix.
At least with this change, we now have the same TOC with Sphinx and
DocBook.
(From yocto-docs rev: 3c73d64a476d4423ee4c6808c685fa94d88d7df8)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
33 lines
1.4 KiB
ReStructuredText
33 lines
1.4 KiB
ReStructuredText
****************************
|
|
Customizing the Standard SDK
|
|
****************************
|
|
|
|
This appendix presents customizations you can apply to the standard SDK.
|
|
|
|
Adding Individual Packages to the Standard SDK
|
|
==============================================
|
|
|
|
When you build a standard SDK using the ``bitbake -c populate_sdk``, a
|
|
default set of packages is included in the resulting SDK. The
|
|
```TOOLCHAIN_HOST_TASK`` <&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_HOST_TASK>`__
|
|
and
|
|
```TOOLCHAIN_TARGET_TASK`` <&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK>`__
|
|
variables control the set of packages adding to the SDK.
|
|
|
|
If you want to add individual packages to the toolchain that runs on the
|
|
host, simply add those packages to the ``TOOLCHAIN_HOST_TASK`` variable.
|
|
Similarly, if you want to add packages to the default set that is part
|
|
of the toolchain that runs on the target, add the packages to the
|
|
``TOOLCHAIN_TARGET_TASK`` variable.
|
|
|
|
Adding API Documentation to the Standard SDK
|
|
============================================
|
|
|
|
You can include API documentation as well as any other documentation
|
|
provided by recipes with the standard SDK by adding "api-documentation"
|
|
to the
|
|
```DISTRO_FEATURES`` <&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES>`__
|
|
variable: DISTRO_FEATURES_append = " api-documentation" Setting this
|
|
variable as shown here causes the OpenEmbedded build system to build the
|
|
documentation and then include it in the standard SDK.
|