Commit Graph

7 Commits

Author SHA1 Message Date
Anas Nashif df64bba4d7 doc: build system documentation cleanup
Change-Id: I8a55b103f4143770c74434c376c4d1770a0374e3
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:34 -05:00
Anas Nashif 68f6032006 doc: fixed inclusion of files to avoid warnings
Change-Id: I454a998851f3546f98601ff3b24770e32cf3b268

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:34 -05:00
Anas Nashif eb53f38f87 doc: move kbuild files into a sub-directory
Change-Id: Iaa18369a32c20cef7bab2327689ab744f28cadcc

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:24:23 -05:00
Rodrigo Caballero 7c995f33b3 doc: Edit the Kconfig Reference Guides.
Edit text for grammar, style, markup, linkage, consistency and clarity.

Change-Id: I785179f867435f9d212718e10acc9e9c8f0f1e8a
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:24:22 -05:00
Rodrigo Caballero 5753b6e4dc Doc: Restructure clean up.
This commit fixes all warnings about cross-references and file names. It
addresses all mark-up issues. Only the warnings regarding Doxygen
objects and files that are intentionally not added to a toctree are left
unhandled.

Change-Id: I5d840522ea0bade4f183e447745244aecf893c94
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:15:33 -05:00
Allan Stephens fa2e040198 doc: Enhance usability of top-level documentation page
Regroups documents into 3 sets::

1) Documents needed when first encountering Zephyr. (Basically what
   you need to decide if you're interested in Zephyr, what it can do
   for you, and how to get the code so you can experiment with it.)

2) Documents used when developing new Zephyr software.

3) Reference documents for Zephyr. (Having these on the main page
   instead of a sub-page make sense, since the API guide and
   configuration option guide will be consulted frequently by users.)

Change-Id: Ifee7ac83f041c24e1efbe3ba7379c21a2ba8b9bc
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-02-05 20:15:21 -05:00
Rodrigo Caballero d7c32911c4 Doc: Create the Reference Guides part.
Placeholders were created for the missing content. The automatically
generated API docs were separated from the Doxygen collaboration guide.
The Kbuild User's Guide was moved unchanged.

Change-Id: I07dfed61bfbb3cad60372c57dc3cbdf627c872f0
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:15:20 -05:00