mirror of
https://git.yoctoproject.org/poky
synced 2026-01-29 21:08:42 +01: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>
63 lines
2.6 KiB
ReStructuredText
63 lines
2.6 KiB
ReStructuredText
******************************************
|
|
The Yocto Project Development Tasks Manual
|
|
******************************************
|
|
|
|
.. _dev-welcome:
|
|
|
|
Welcome
|
|
=======
|
|
|
|
Welcome to the Yocto Project Development Tasks Manual! This manual
|
|
provides relevant procedures necessary for developing in the Yocto
|
|
Project environment (i.e. developing embedded Linux images and
|
|
user-space applications that run on targeted devices). The manual groups
|
|
related procedures into higher-level sections. Procedures can consist of
|
|
high-level steps or low-level steps depending on the topic.
|
|
|
|
This manual provides the following:
|
|
|
|
- Procedures that help you get going with the Yocto Project. For
|
|
example, procedures that show you how to set up a build host and work
|
|
with the Yocto Project source repositories.
|
|
|
|
- Procedures that show you how to submit changes to the Yocto Project.
|
|
Changes can be improvements, new features, or bug fixes.
|
|
|
|
- Procedures related to "everyday" tasks you perform while developing
|
|
images and applications using the Yocto Project. For example,
|
|
procedures to create a layer, customize an image, write a new recipe,
|
|
and so forth.
|
|
|
|
This manual does not provide the following:
|
|
|
|
- Redundant Step-by-step Instructions: For example, the `Yocto Project
|
|
Application Development and the Extensible Software Development Kit
|
|
(eSDK) <&YOCTO_DOCS_SDK_URL;>`__ manual contains detailed
|
|
instructions on how to install an SDK, which is used to develop
|
|
applications for target hardware.
|
|
|
|
- Reference or Conceptual Material: This type of material resides in an
|
|
appropriate reference manual. For example, system variables are
|
|
documented in the `Yocto Project Reference
|
|
Manual <&YOCTO_DOCS_REF_URL;>`__.
|
|
|
|
- Detailed Public Information Not Specific to the Yocto Project: For
|
|
example, exhaustive information on how to use the Source Control
|
|
Manager Git is better covered with Internet searches and official Git
|
|
Documentation than through the Yocto Project documentation.
|
|
|
|
Other Information
|
|
=================
|
|
|
|
Because this manual presents information for many different topics,
|
|
supplemental information is recommended for full comprehension. For
|
|
introductory information on the Yocto Project, see the `Yocto Project
|
|
Website <&YOCTO_HOME_URL;>`__. If you want to build an image with no
|
|
knowledge of Yocto Project as a way of quickly testing it out, see the
|
|
`Yocto Project Quick Build <&YOCTO_DOCS_BRIEF_URL;>`__ document.
|
|
|
|
For a comprehensive list of links and other documentation, see the
|
|
"`Links and Related
|
|
Documentation <&YOCTO_DOCS_REF_URL;#resources-links-and-related-documentation>`__"
|
|
section in the Yocto Project Reference Manual.
|