README - OpenGrok cross reference for /OK3568_Linux_fs/yocto/poky/documentation/README

1 documentation
4 This is the directory that contains the Yocto Project documentation.  The Yocto
6 instances of the "documentation" directory.  You should understand each of
9   poky/documentation - The directory within the poky Git repository containing
11                        poky Git repository, the documentation directory
18   yocto-docs/documentation - The Git repository for the Yocto Project manuals.
21                              Yocto Project documentation, you should set up
56 This file defines variables used for documentation production.  The variables
62 This file specifies some rules to follow when contributing to the documentation.
73 The Yocto Project documentation was migrated from the original DocBook
74 format to Sphinx based documentation for the Yocto Project 3.2
77 contribute to the Yocto Project documentation.
80    beautiful documentation, written by Georg Brandl and licensed under
82    documentation.
84 Extensive documentation is available on the Sphinx website:
88 documentation.
90 Yocto Project documentation website
93 The website hosting the Yocto Project documentation, can be found
96 The entire Yocto Project documentation, as well as the BitBake manual,
103 versions of the Yocto Project documentation with links to each manual
106 How to build the Yocto Project documentation
111 documentation with Python3.
132 To build the documentation locally, run:
134  $ cd documentation
138 can browse your own copy of the locally generated documentation with
144  $ cd documentation
151 The Yocto Project documentation is currently based on the "Read the
153 of the project documentation is preserved.
212 The Yocto Project documentation makes heavy use of global
221 to mimic the DocBook based documentation behavior. Variable
227 documentation/sphinx/yocto-vars.py, this extension is enabled by
228 default when building the Yocto Project documentation.  All variables
258 The Yocto Project documentation has many figures/images. Sphinx has a
260 figure in the body of the documentation:
289 documentation/manual/intro.rst, use:
299      are defined in the project documentation:
313 the 'documentation/conf.py' file:
331 documentation rst files, as:
341 documentation projects, such as the BitBake manual.
358 Submitting documentation changes