Running documentation scripts on the top directory shifted all links one
level dowwn and is breaking all incoming links.
Use a script to copy all RST files into the doc/ directory before
running sphinx and keep structure intact.
Jira: ZEP-1579
Change-Id: Iccff068430e2ddb29e172cd8ae920475815d199e
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This will allow inclusion of documentation files that exist outside of
doc/ and will make it possible to add rst files across the tree,
especially for boards, samples and tests.
Change-Id: I7afcf92d99f504b2bc0b2b7e3452acb2f8e08294
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Merge build system and application primer into one and put
all in one file to make it easier to follow.
Jira: ZEP-686
Change-Id: I64ec7ef7a6aa2ad80496ca0ee3ddc3d7fe09a5d7
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
The Zephyr kernel tree has imported or reuses packages, scripts that
are not covered by the Apache LICENSE.
As in some places it is not clear (there is no LICENSE file or way to
put it there), here we list them to ensure there is proper license
acknowledgement.
This is an initial proposal--I welcome feedback on everything,
especially where to link the documentation (kind of kludgy now) and
more missed components from this initial list.
v5: Added David Kinder's feedback
v4: Fixed more typos in Makefile
v3: fixed some more typos, but still holding on to feedback on how it
can be done with SPDX files, as it is not yet all clear to me.
Jira: ZEP-1079
Change-Id: Ie1bf545e26b0d304cd3ea0d70cdfc13d520197fe
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Each tagged version of the documentation associated with a build is
available on the website. This patch adds the link to the 1.5.0 version.
Change-Id: I664ec08598eacbdccbdfb1a5cec3791ea879edb0
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Link to the 1.5 version of documentation shouldn't be added
to the documentation home page until AFTER the release documents
are pushed to the site. (I thought this would have been done when
the code freeze happened.) Remove the 1.5 link for now and wait
until after the 1.5 docs are pushed.
Jira: ZEP-730
Change-Id: Ia225c9ce3ffb52540fb43f105a3cd40e72d0cf4a
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Relocates the introductory material for Zephyr into a new document,
so that it can be more easily located by users. (Previously this
info couldn't be accessed from the list of documents on the left hand
side of a web page; instead, you had to click on the "Documentation"
tab at the top of the page, which is non-intuitive.)
Change-Id: I1e1f78162a314b958789fcef57fc864336007f3c
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
Groups top-level documents so that related documents are adjacent.
Also re-orders things so that documents for newcomers appear before
documents on more advanced topics.
The rationale behind the resulting order is described below:
Getting Started Guide
- Enables a newcomer to access & try out Zephyr by running a sample
application using QEMU.
Supported Boards
- Enables a newcomer to try out Zephyr by running a sample application
using actual hardware.
- Also lets newcomers know which boards are currently supported.
Zephyr Kernel Primer
Device Drivers and Device Model
Subsystems
- Describes the various components of the Zephyr kernel.
- Lets a developer know what is available when they are *designing* code.
API Documentation
- Describes the various APIs of the Zephyr kernel.
- Lets a developer know what is available when they are *writing* code.
Application Development Primer
- Provides the info needed for a developer to create a new application
using Zephyr.
Contributing Code
- Tells a developer how to contribute code back to the Zephyr project.
- Advanced topic.
Porting Guides
- Provides guidelines for porting Zephyr to a new architecture.
- Advanced topic.
Build System User Guide
- Covers writing Kconfig options, and also contains reference guide.
- Advanced topic.
Change-Id: I8ecb4953c788e843028d1e8778be1ef1aee6c175
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
update index.rst to include 1.4.0 doc folder
Change-Id: I57b7ea470e4a5d2f8e93459f90421a87abf331ce
Signed-off-by: David Kinder <david.b.kinder@intel.com>
Warnings about duplicate label (_about_zephyr) crept up because of the
way the about_zephyr document was included in the index. This is a
short document, makes sense to have it as part of the index.rst; it
removes clutter from the directory as well as the warning.
Change-Id: Ifdc3a93fb4316be4aef685257d14749769443b41
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
The fixed link was broken when development documentation started being
hosted at /doc instead of /doc/dev
Change-Id: I3621bf83beb030e7d80f60e1d148cd7311d25cdf
Signed-off-by: Genaro Saucedo Tejada <genaro.saucedo.tejada@intel.com>
Explanations and guidelines when porting Zephyr to a new processor
architecture or ABI.
Change-Id: Ibb3a26636dca6b248103e4744c333911c2af0e50
Signed-off-by: Benjamin Walsh <benjamin.walsh@windriver.com>
show different information based on the state of the current
documentation and link to development version and released
versions depending on where the user lands.
Change-Id: Ifa6263900222db483efa0388e2588dd97222ecb6
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
contribution guide is now a top level document and other guides
are being moved to the wiki.
Change-Id: I1e207e18659f3aa98111cfaa1597478ff29eedef
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
- Consolidates the links to the sections in a single table of contents.
- Adds the documentation's version number.
- Adds a link to the project's Wiki.
Change-Id: I762d30ce8cbf518df8a28e428e94a2f9a3c7085d
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Add sensors and networking into the new section and seperate
those from the kernel documentation.
Change-Id: I585845c3ba09173ced7caa0b7fbc1f1a81a26f96
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Put all device drivers and device model documentation into one
section.
Change-Id: Iba6a50796b02b7f9234c23dca706be62fd7b4259
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Search engines recommend having only one heading on level 1.
Modified the headings in the documentation index file to
follow the recommendation and help ensure that search engines
place Zephyr higher on their results lists.
Change-Id: I5590138f88721d1f2cdcbb49ad2aaad1d2dcd466
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Supported platforms section (platforms.rst) renamed to "boards.rst"
and broke into two tables instead of one (x86 arch and ARM arch).
Developer feedback was that navigating for board config options
by board architectures should be made easier.
Also updated index w/TOC to make supported board details
easier to find.
Change-Id: Ic014a720fd33ee685bde5809dc5b9e0622f5e989
Signed-off-by: L.S. Cook <leonax.cook@intel.com>
Restructured the API documentation and moved it from the Reference
section to the Developer guides section.
Added a note about the search function to help users find the API they
are looking for faster.
Splitted the API docs into two files one for nanokernel and another for
the microkernel APIs.
Added table of contents for each of the API sections with a back link on
the headings to take the users back to the top of the page. Making
navigation easier and more user friendly.
Change-Id: I80f415a60ea9c7df22276b464013e906e1efa511
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Restructured the guide to follow a basic three step process: Set up, develop,
build. All information that is independent of the OS selection was taken out of
of the OS related documents and placed in the general set up sections.
A new section, Developing Zephyr Applications, was added with links to all the
development relevant section of the documentation.
The content in local_development.rst was split between the setting_up.rst,
installation_linux.rst and installation_mac.rst files as appropriate.
This new structure provides a much better flow for developers beginning their
Zephyr develpment.
Applied all of Inaky's suggestions in the refactored content.
Minor markup fixes and language edits were also perfomed during the refactoring.
Fixed a cross-reference that was broken during the refactor.
Applied all the feedback from the first trial run.
Applied the feedback provided by David Kinder from TCS.
Change-Id: I3368a3a41ec9ad02cc4e7b37fe71c65abd8a7df9
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Removes permalinks and sets the correct version and release. The change places
the copyright notice and license in the footer of every page.
Both copyright and license do not appear in the website's version.
Change-Id: Idb5171b24af004fc2f7aff42aab43469f26305b4
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
Also move about_zephyr back to main page and remove duplicated
examples for nano kernel.
Change-Id: Icbc899ce5688d853a59dfc5c8d50f34048ed212b
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
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>
The master files are changed to reflect the new structure. This
structure is identical to the proposed structure.
Change-Id: Ic8e205d84f8a0b7f60fad621073c95af11008cb8
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
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>
Provides high level background material for Zephyr, to help newcomers
easily determine its suitability for their needs.
Change-Id: I2f843ad627024f601f163eafc7d965ecf44da8f9
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
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>
The content of the files was left unchanged except for labels for
cros-referncing, the main title of the part and the tabs on the tables
which were changed to spaces. That last change ensures the integrity of
the tables independently of editor. The structure of the content files
will be revised at a later time.
Change-Id: I90477966fb3f4727d61e859d77682b529c83337d
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Moves the content found in the development part to the new Application
Development Primer. Creates a master file for the new part and a
placeholder for nanokernel-only applications. Labels that have already
been changed in prior changes of the topic were updated. The project's
master file was changed to include the new part.
Change-Id: I8e9df5b3e5d382997caf62b7503274e4821137e0
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Creates the Kernel Primer, removes overview modules that are no longer
needed and updates the master file to include the new part.
Change-Id: I6d7f53f019089d502e763ecc1789fb152c90c465
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The Quick Start Guide is now comprised by Installing, Building and
Running the Zephyr Kernel Guides. The Installing Guide contains all the
procedures needed to install the required components and get access to
the code. The Building Guide contains the procedure to build the kernel
using a sample application. The Running Guide contains the procedures to
run an application using QEMU or the Galileo 2 board. Files and folders
were renamed. The toctree directives were updated to reflect the new
names.
Change-Id: I4398befd4a24b12a50970c21a5288afa5c533fc8
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
The contents are split in two: Zephyr Kernel and Zephyr Project. Under
Zephyr Kernel is all the content directly about the code base. Under
Zephyr Project is all the content about the development of the kernel
and of applications. Only the Doxygen document needed to be split. The
output of the in-code comments was placed under the Zephyr Kernel while
all the Doxygen guidelines and the extraction process information were
placed under the Zephyr Project.
Change-Id: I4f7b674d19449968e976b63f40bcaa9737cc0ecb
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Adds infrastructure for platform configuration guides,
starting with the fsl_frdm_k64f platform configuration.
Incorporates inline sphynx tags except :guilabel:
which does not bold gui labels, a feature needed
for scanning a procedure for key info.
Change-Id: I4f5154dae896449fb709842501c69d8757deca3e
Signed-off-by: Carol Lee <carol.lee@windriver.com>
The architectural overview of the OS contains the general information
regarding the nanokernel, the microkernel, the driver model and the
application model.
Change-Id: I5a16f3f5ec5023239a772d3e559bd761795c27d4
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Anas Nashif