linux/poky.git/documentation/README, branch yocto-3.1.17

documentation: Add Pipenv support

2021-01-04T10:55:02+00:00

Adds a Pipfile so that Pipenv can be used to automatically install all the dependencies required to build the documentation (From yocto-docs rev: 5fc0a3011c47388d9c6447c3be00fefcbaf00f5c) Signed-off-by: Joshua Watt Signed-off-by: Richard Purdie (cherry picked from commit 31658ad30827d38dcd4ea83bcfb828441c7c3eca) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

README: "yocto-project-qs" -> "brief-yoctoprojectqs"

2021-01-04T10:55:02+00:00

Directory has been renamed, so fix README and add a bit more white space to keep everything lined up. (From yocto-docs rev: 98da73f772f5ad8edb47f7c6d1e1c55133d51fdd) Signed-off-by: Robert P. J. Day Signed-off-by: Richard Purdie (cherry picked from commit cdd4c705f7271e31e44a94c79b050eda1fba5945) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: rename Makefile.sphinx

2021-01-04T10:55:01+00:00

Now that the DocBook files are removed, we can rename the top level Makefile. (From yocto-docs rev: eb412a93ec93b3413e23f028f33bda88f82ac688) Signed-off-by: Nicolas Dechesne (cherry picked from commit 25fefa9a91ba5d7b398443f543e2c46165e8a3f4) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

sphinx: import docs

2021-01-04T10:55:00+00:00

The Yocto Project docs was migrated from Docbook to Sphinx in YP 3.2. This 3.1 is an LTS release, and since 3.1 docs are 'close to' the docs in 3.2, we agreed to backport sphinx docs onto 3.1. This first patch brings all changes done in 3.2 until: 7f64574f7 README: include detailed information about sphinx There are other changes after this commit, but they will be selectively backported in individual patches. This patch was generated with the following command: git cherry-pick -n \ $(git log --reverse --oneline \ ac352ad7f95db7eeacb53c2778caa31800bd7c26..7f64574f7 \ | cut -f1 -d' ') The following commits were applies in the dunfell docs, but not in master, so they were first reverted (and squashed into this change). A commit will reintroduce the content from these patches in the Sphinx files in a followup patch. 069c27574 Documenation: Prepared for the 3.1.1 release bd140f0f9 Documentation: Add 3.1.1 version updates missing from previous commit 17cc71a8f Documenation: Prepared for the 3.1.2 release 1a69e2c02 Documenation: Prepared for the 3.1.3 release 8910ac1c7 Documenation: Prepared for the 3.1.4 release (From yocto-docs rev: c25fe058b88b893b0d146f3ed27320b47cdec236) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie

documentation: Updates to change dev-manual title

2017-10-30T15:55:06+00:00

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 Signed-off-by: Richard Purdie

README: Updated to remove the ADT manual and add the SDK manual.

2016-04-06T22:11:58+00:00

(From yocto-docs rev: 61474479f84e2f611684db152e7682275f8f19c3) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie

README: Updated the file to reflect current state of documentation

2013-08-13T12:18:36+00:00

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 Signed-off-by: Richard Purdie

documentation/README: updated to include website information.

2012-09-24T15:36:05+00:00

(From yocto-docs rev: 439bd3c11e46d653234da928cfea6ab46666f0f2) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie

documentation/README: Updates for mega-manual

2012-09-04T11:54:59+00:00

Added information about the mega-manual. (From yocto-docs rev: bbf75682f957ad2e124aa9476f52cd2bd3829fa6) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie

documentation/README: Updates to explain development

2012-03-23T14:24:48+00:00

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 Signed-off-by: Richard Purdie