Copy the generated files in the special _static directory.
Fixes [YOCTO #14357]
(From yocto-docs rev: b60c5b86eaef5ddab026837e0952a28c7948bc2d)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This patch makes the "latexpdf" target compile the documentation with
xelatex instead of the default pdflatex engine.
The reason behind this is stated in [YOCTO #14357]: pdflatex does not
support compiling foreign characters, so we need to resort to another
engine, here xelatex.
It also increases the texmf config buf_size to 10000000 to avoid a
compilation error.
(From yocto-docs rev: bd6265ca323fac547a197bb516dc4a9ef3897508)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Remove inkscape as it is not part of meta/, and use librsvg so we can
ship it in a buildtools tarball for the autobuilder workers.
(From yocto-docs rev: 2d92de35e0029bf151c9a0c0e696a127cef14082)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
make sphinx-lint runs sphinx-lint on the whole documentation which can be
long and reports a lot or errors/warnings. Let's add a new
SHPINXLINTDOCS variable to allow specifying a subset, just as VALEDOCS
does. Keep variable assignment aligned and also use $(SOURCEDIR) by
default for SPHINXLINTDOCS and VALEDOCS variables.
Also update the README file and fix a typo in Link checking section
title.
(From yocto-docs rev: 3dfe7b5c746af31de74f67cf88214e5d52bdb65d)
Signed-off-by: Julien Stephan <jstephan@baylibre.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Tested-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Makes it possible to catch errors not reported by sphinx,
such as idle spaces. After customization, this should be used
to enforce our syntax conventions, such as two spaces after a "-"
character to introduce a list item.
Just run "make sphinx-lint".
(From yocto-docs rev: 9e1aeeddca06cb7d65631010ba0eebdcd8ecf9ee)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Use the "Vale" (https://vale.sh) tool to perform text style checks
Run "make stylecheck" to run the checks.
This just checks the text, not the Sphinx syntax style choices.
(From yocto-docs rev: 51b1f9a4d5aa02d337b105633de38e18b923a13a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
releases.rst is generated by the set_versions.py script
(From yocto-docs rev: 4b7773f59bab2d653d07b7e06cd21745b646b604)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Use the "Vale" (https://vale.sh) tool to perform text style checks
Run "make stylecheck" to run the checks.
This just checks the text, not the Sphinx syntax style choices.
(From yocto-docs rev: d145e1dc45dc0792c8b8f7e73500b56face1e710)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixing "make clean" followed by "make epub" or "make latexpdf"
(From yocto-docs rev: 0dac10fc3d170fb162f4df6547541071bfa7a94e)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Use a script to generate the branch/tag information inside poky.yaml.
If the branch isn't a known release branch, include git magic to find
the closest matching release branch we know about.
(From yocto-docs rev: 841e2df0e2e544b82fff9ddd0339a4e775148e3a)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
html output is great when directly using SVG
epub output has to use exported PNG because of issues using SVG directly
latexpdf output cannot use SVG, it needs exported PDF instead
This adds rules to generate PNG and PDF formats from new SVG sources.
Newly added diagrams have be stored in svg/ subdirectories
so that PNG and PDF files generated from SVG can be "gitignored"
without ignoring the original PNG diagrams that have no SVG source.
Note: had to remove the dependency to "Makefile" in the final "catch-all" target,
otherwise it was also catching the SVG to PNG and SVG to PDF targets.
(From yocto-docs rev: cd9bbd41d323bc124057396f142010509c65bbaf)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-W is for turning warnings into errors, --keep-going to make sure the
whole documentation is built and all warnings will be printed before
failing.
Since there's currently no warning, it's time to introduce it!
(From yocto-docs rev: 5d7b8547549b2203a03df617cdba70ccf2194c62)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
>From sphinx-build man page:
-j N build in parallel with N processes where possible
(special value "auto" will set N to cpu-count)
(From yocto-docs rev: 1847aeea8b88c84f821610803264955e51e31d2f)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Now that the DocBook files are removed, we can rename the top level
Makefile.
(From yocto-docs rev: 25fefa9a91ba5d7b398443f543e2c46165e8a3f4)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The Yocto Project documentation was migrated to Sphinx. Let's remove
the deprecated DocBook files.
(From yocto-docs rev: 28fb0e63b2fbfd6426b00498bf2682bb53fdd862)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a few comment lines in Makefile to commemorate Scott's
contributions
(From yocto-docs rev: 07c88e2724a223b26694c98c0e976d735aee00e6)
Signed-off-by: Jefro <jefro@jefro.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The newly created section on how to create NPM packages
required a figure. I added the figure to both the dev-manual
and mega-manual tarballs creation areas.
(From yocto-docs rev: 5109274d107b6d3ae6be3f71a20379cb6abb39d6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the file so that Eclipse help for YP manuals is
not generated. Updated comments to remove examples of
Eclipse.
(From yocto-docs rev: db62b107e82a9d6fad619b03d57e807b3a617afd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12399]
Fixes made to have the BitBake User Manual included in the build
of the mega-manual. I placed this manual at the end of the
mega-manual. Following changes made:
* Makefile - Modified to include two PNG files. All PNG files
in a given manual are listed in the area that makes
the mega-manual so that the tarfile is complete.
* mega-manual.xml - Updated the front wording to tell the user
that the BitBake User Manual is included in the
Mega-Manual. Also, added a last section to actually
include the bitbake-title.png file and the *.xml
files. Note that I could not add the title figure
from the same figures folder of the local "bitbake"
folder. Would not include in the build. So, I
pulled the file from the figures folder of the
mega-manual, which is what I do for all the other
book titles used in the mega-manual.
* mega-manual.sed - Modified to clean out the old stuff that
had been carried along for older books not
supported for the release. Modified to include
link processing for the newly included BitBake
User Manual.
* New Figures - Moved copies of the "bb_multiconfig_files.png"
and "bitbake-title.png" figures into the
figures folder of the mega-manual.
(From yocto-docs rev: 78a1ae0ca92bb7f8a9d3a32a320299371d0ed361)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Rewrote the section on setting up and executing multi-config builds.
Broke the section into two sub-sections. One is for the standard
information that was there for setting up a multi-config build. A
new section was for the cross-build dependencies in multi-config
builds.
Part of the re-write included creating a new figure that shows
the configuration file hierarchy needed for these types of builds.
So, new figure added to both the dev-manual and the mega-manual
figures directories.
Finally, the Makefile needed updated to account for the new figures.
(From yocto-docs rev: dc158e97c216aa6e7fa3755164409d581f8569c5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The Makefile-Based Projects section was expanded to add a useful
example and figure. Added this figure to the sdk-manual and
mega-manual figures folders.
Updated the Makefile to include the new figure as part of the
tar files for each manual.
(From yocto-docs rev: 6261cb55b6393e0d5dce91cdb7c8e6e83849ec0c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New figure for the section on Autotools workflow. The figure
goes in the folders for both the sdk-manual and the
mega-manual.
Updated the Makefile to include the new figure in the tarball
when creating both manuals.
(From yocto-docs rev: ccb2c4b9ebd0b0aaa55b5790eb6a916701e10af4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
That figure is no longer used in the manual set. The newer,
more aesthetically pleasing one is.
(From yocto-docs rev: 853567672533777aa5d9baa3969d08673a8dd71f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This involved changing the root manual folder from
"getting-started" to "overview-manual".
Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was
changed to "YOCTO_DOCS_OM_URL". Most manuals had several
occurrences of these links.
The makefile needed updating to process the new manual
and not process the old "getting-started" manual.
(From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The variabe for the "getting-started" manual goes away and is
replaced by this one for the new "overview-manual."
(From yocto-docs rev: 45fc9beac6db4c40c3660fc9e54cc11e9c1f96c4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This file is not part of 2.5.
(From yocto-docs rev: a0ad3a90869c7dca729cce7db5fb7004e0272211)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This manual will not see existance. I put the list of .png files
from this manual into the existing getting-started manual as that is
where the topics will now go.
(From yocto-docs rev: 22c2de06baf96120cbc830540e818599ce0ac07b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The original QS (yocto-project-qs) has been retired for the YP
sumo (2.5) release. The manual has been replaced with the
brief, two-page quick build document (brief-yoctoprojectqs).
I needed to create a new title figure for the manual to include
as part of the mega-manual (bypqs-title.png). The figure was
added to the figures folder of both the bried-yoctoprojectqs
and mega-manual book folders. I also removed the old
ypqs-title.png file that was used for the original QS.
Updated the stylesheet doc for the brief build to include a
style using the new title .PNG file.
Updated the mega-manual.xml file to include the brief doc and
exclude the original QS.
(From yocto-docs rev: aadec4a70fa89e4dcd233c337d8971c8353ee26d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I have created an brief article in the form of current YP docs
that is a pared down version of the Quick Start (pre 2.5 release).
The article fills a gap for a short (2-page), process-oriented
article that steps the user through an initial build using YP.
I had to make changes to the Makefile to support building the new
article.
(From yocto-docs rev: 47aace60cea4a892ae1efabb050b240c6abdaec9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the new section "Reference Embedded Distribution (Poky)"
section to the getting-started manual. The new section required
a new figure. I had to add the figure to the figures folder of
both the getting-started and mega-manual books. Updates to the
Makefile to include the new figure as part the tarfiles created
for each book.
(From yocto-docs rev: e5f44e17d4c1e55b6f229cc3745727e439b5bcb7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Created content for "What is the Yocto Project" section.
Involved a new figure that had to be shared in the mega-manual
figures folder.
(From yocto-docs rev: 72c18abd11587f4d78848afb8a71ff7f4a0e76d0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The list of *.png files included in the TARBALL variable setting
changed due to figures moving from the getting-started manual to
the concepts-manual.
(From yocto-docs rev: 1439fa9f22a2b2746aa8e8303205f5ec33c7f67b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Creation involved removing the overview-manual and replacing it
with the getting-started manual. All links to the string
"&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with
"&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed
files used to create the manual with prefixes suited for the
new manual name, which is "Getting Started With Yocto Project".
The style sheet for the new manual needed updating to display the
new .PNG image for the title page. The mega-manual file had to
be updated to include the files. The mega-manual.sed file had
to be updated to include the new manual and not use the overview
manual.
(From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
The section in the ref-manual on build history has been moved to
the dev-manual. It is more of a "how-to" piece of information than
a reference.
(From yocto-docs rev: 9634bd8dc51e2972e6a5f3a3d3b4256c8ca8749c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
The section in the ref-manual that overviewed the buld process was
redundant and more of a "how-to" topic. I have moved and merged it
into the dev-manual into a similar area.
(From yocto-docs rev: 44f1351334342629aaa0976f62e64ac4f67166aa)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
Moved the "Cross-Development Toolchain Generation" section from the
ref-manual to the overview-manual into the concepts chapter. This
information is conceptual and now needs to live in the concepts
chapter of the new overview-manual. Moving the section caused a
few links to have to be fixed in the ref-manual. There was also a
figure in the section. So, I had to move the figure from the ref-manual
to the overview-manual "figures" folder and update the Makefile for
the TARFILE generation.
(From yocto-docs rev: 1f3ee5ab308cbe6bd7194086026db397b67ca7c4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
Moved an introductory section for YP that was in the ref-manual
to the beginning of the YP environment chapter of the overview-manual.
Had to move a figure and update the makefile as well as adjust some
links.
(From yocto-docs rev: 8ec45f945a21b1f64e7529b95df6b5fb21e87449)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
Added a new chapter to the newly created Yocto Project Overview
Manual. This chapter originated from the YP Reference Manual and
was the old chapter 3, which talked a lot about various concepts.
This information is better suited for the new overview manual.
The change involved moving the entire chapter and renaming it.
This move of the content affected many, many external references
and links into the old area. Consequently, I had to recast all
these links from the different manual.
Changes also included fixing the mega-manual.xml file so that it
would include the new overview manual as part of it.
Many figures had to be relocated as part of the move as well. This
meant deleting them from the ref-manual/figures folder and putting
them into the overview-manual/figures folder.
(From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
I added all the mechanics for this new "Yocto Project Overview Manual".
For now, the manual builds and publishes into the 2.5 area. I used
"overview-manual" for the folder name. Makefile properly builds the
new manual. The mega-manual.sed file processes links for the new manual.
The mega-manual.xml file includes the new manual. The poky.ent file
includes a new ENTITY link for the overview manual. All pieces are in
place.
With this commit, just an overview chapter exists. The remaining content
needs to be developed.
(From yocto-docs rev: 632ebd4a91920585e736527e070ca8363a00f41b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the way the YP QS looks. The QS now has numbered sections
rather than just formatted section heads. This allows the reader
to better track the hierarchy of the sections. This feature has
been asked for before and I decided it was time to implement it.
One thing though, is I am not generating a full TOC at the head
of the book as is done in the other YP manuals.
Decided to add a manual title .PNG file. This required a new figure
file (ypqs-title.png) that needed to reside in the figures folder of
both the yocto-project-qs and mega-manual. Updates were required in
the Makefile to include the figure. Updates required in the
YP QS style sheet to display the figure. Basically, there were all
kinds of changes to get this title to show up properly in both the
YP QS and in the Mega Manual.
Turned the structure of the YP QS into a book now rather than an
article. This required creating a "qs.xml" file that has the actual
content.
(From yocto-docs rev: ef05f5c7ba2a61ebc4c58873cbbc32d35652659d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
File is not used.
(From yocto-docs rev: 83eb6d4decfe698a5f4be9c3c9792ef60e404323)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
