Anchor links are treated by Sphinx as external links and are not checked
during build, meaning it is impossible to know if a link becomes broken or
not.
As a matter of fact, most of the anchor links replaced in this commit
were actually broken.
The README now states that anchor links are forbidden so that there's no
need to go through such a change later on.
(From yocto-docs rev: de9e4d26b46afa3c79137d07529a74553400d2e0)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Minor style and spelling fixes
- Add some extra details; add missing external link macros
and explain where they are defined
- Correct where documentation can be found on the
Yocto Project website: the "Documentation" tab
has been replaced by "Docs" (and it's later
shown as uppercase ("DOCS") by the current CSS, but this
may change one day.
(From yocto-docs rev: ed7b4f318c9ba6cf501f1e551c7a8eb4aaee1396)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the "Yocto Project Quick Build" instructions
(https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html#)
there is an inconsistency that impacts several documents...
People are first instructed to clone the poky git repository, but not
mentioning from which directory. Then, it's consistent to instruct
people to run "cd poky/".
However, later in the instructions, readers are instructed to run "cd
~/poky", which assumes that cloning poky was done from the home
directory. Many other places in the documentation make such an assumption.
This change fixes this, and makes no assumption on where people
have chosen to store their data, in particular where they cloned
the "poky" repository.
This also fixes a few whitespace issues.
(From yocto-docs rev: fd4e365c85df212d7ed70fc1abb3657a4a88b294)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This may help anyone looking for patch contribution guidelines in the
documentation directory itself.
(From yocto-docs rev: 276740dd3780b0bdf04996efeed3c237fd26da1f)
Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Adds a Pipfile so that Pipenv can be used to automatically install all
the dependencies required to build the documentation
(From yocto-docs rev: 31658ad30827d38dcd4ea83bcfb828441c7c3eca)
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Directory has been renamed, so fix README and add a bit more white
space to keep everything lined up.
(From yocto-docs rev: cdd4c705f7271e31e44a94c79b050eda1fba5945)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
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>
* Updated the README to include instructions to build the doc with
sphinx
* Added design guidelines for new contributors
(From yocto-docs rev: 7f64574f7594de22fbd29d9da9b8c9df4ba05ffb)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated several files to change the title of the dev-manual from
the "Yocto Project Development Manual" to the "Yocto Project
Development Tasks Manual." Did some edits in the README and the
Makefile as well for completeness.
(From yocto-docs rev: 0278d6d3bb458af1cb04fbc3eed96dff12d19475)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This file was out of date. I replaced the kernel-manual descriptions
with dev-kernel. Also, added the profiling manual. Finally, changed
the poky-ref-manual string to ref-manual.
(From yocto-docs rev: a1e60078dcfcfd5a912d78f981fe70dc1aa33e37)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added information that describes the relationship between
poky/documentation and yocto-docs/documentation. For developers,
they need to know to work from the yocto-docs Git repository
and not to rely on the poky/documentation Git repository, which
can lag behind the other one.
(From yocto-docs rev: 0cbc781d3e9544c9920fdaf4548d882dd79b3d6c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
