OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/doc/index.rst

47 lines
614 B
ReStructuredText
Raw Normal View History

ADD framework files for ReST content. Includes the documentation license, a substitutions file and a README detailing the new infrastructure and its installation. Updates the master file, index.rst, to accomodate the content files. Change-Id: I529567e6e29d24a4261c0fa4b3db1176266f9777 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-05-16 00:38:34 +08:00
..
Fix the index page and headers - Put license at the bottom - Add a title - Change disclaimer from a heading to a rubric Change-Id: I19b73e3a0408fd95efb514e75ea4ee028bb8f50c Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-06-14 03:51:09 +08:00
Zephyr Project documentation master file
ADD framework files for ReST content. Includes the documentation license, a substitutions file and a README detailing the new infrastructure and its installation. Updates the master file, index.rst, to accomodate the content files. Change-Id: I529567e6e29d24a4261c0fa4b3db1176266f9777 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-05-16 00:38:34 +08:00
.. include:: documentation_license.rst
Fix the index page and headers - Put license at the bottom - Add a title - Change disclaimer from a heading to a rubric Change-Id: I19b73e3a0408fd95efb514e75ea4ee028bb8f50c Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-06-14 03:51:09 +08:00
Add Disclaimer explaining that the documentation is a work in progress. The disclaimer was added in a separate file keeping the master file index.rst clean. The master file was only changed to include the disclaimers.rst file. Change-Id: I51a56c64dee3285ea3b9be22f0eab477459d8417 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2015-05-26 01:19:03 +08:00
.. include:: disclaimers.rst
Add tools and Makefiles for Documentation This will allow us to start adding content and structure. To generate documentation you will need to install both - sphinx - breathe go into the doc directory and run: $ make doxy html No content has been submitted here, only a few placeholders. Change-Id: Ifc3617aee8f7d45fa4e4a494ff0a1ab71516af06 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-05-14 02:05:30 +08:00
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>
2015-08-13 00:05:08 +08:00
Getting Started
###############
Fix the index page and headers - Put license at the bottom - Add a title - Change disclaimer from a heading to a rubric Change-Id: I19b73e3a0408fd95efb514e75ea4ee028bb8f50c Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-06-14 03:51:09 +08:00
Add tools and Makefiles for Documentation This will allow us to start adding content and structure. To generate documentation you will need to install both - sphinx - breathe go into the doc directory and run: $ make doxy html No content has been submitted here, only a few placeholders. Change-Id: Ifc3617aee8f7d45fa4e4a494ff0a1ab71516af06 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-05-14 02:05:30 +08:00
.. toctree::
Doc: Restructures the Quick Start Guide. 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>
2015-08-07 00:41:40 +08:00
:maxdepth: 1
Add tools and Makefiles for Documentation This will allow us to start adding content and structure. To generate documentation you will need to install both - sphinx - breathe go into the doc directory and run: $ make doxy html No content has been submitted here, only a few placeholders. Change-Id: Ifc3617aee8f7d45fa4e4a494ff0a1ab71516af06 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-05-14 02:05:30 +08:00
doc: Add "About Zephyr" section 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>
2015-08-12 23:20:24 +08:00
about_zephyr.rst
Doc: Create the Kernel Primer. 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>
2015-08-08 02:28:19 +08:00
kernel/kernel.rst
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>
2015-08-13 00:05:08 +08:00
quick_start/quick_start.rst
Developer Guides
################
.. toctree::
:maxdepth: 1
Doc: Creates the Application Dev. Primer with the existing content. 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>
2015-08-08 05:44:34 +08:00
application/application.rst
Doc: Add the Platform Development Primer to the structure. 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>
2015-08-08 06:04:45 +08:00
platform/platform.rst
DOC: Restructures the documentation in two parts. 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>
2015-07-21 04:26:16 +08:00
zephyr_project
ADD framework files for ReST content. Includes the documentation license, a substitutions file and a README detailing the new infrastructure and its installation. Updates the master file, index.rst, to accomodate the content files. Change-Id: I529567e6e29d24a4261c0fa4b3db1176266f9777 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-05-16 00:38:34 +08:00
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>
2015-08-13 00:05:08 +08:00
Reference Guides
################
.. toctree::
:maxdepth: 1
reference/api.rst
reference/configuration.rst
reference/kbuild.rst
ADD framework files for ReST content. Includes the documentation license, a substitutions file and a README detailing the new infrastructure and its installation. Updates the master file, index.rst, to accomodate the content files. Change-Id: I529567e6e29d24a4261c0fa4b3db1176266f9777 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-05-16 00:38:34 +08:00
Add tools and Makefiles for Documentation This will allow us to start adding content and structure. To generate documentation you will need to install both - sphinx - breathe go into the doc directory and run: $ make doxy html No content has been submitted here, only a few placeholders. Change-Id: Ifc3617aee8f7d45fa4e4a494ff0a1ab71516af06 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-05-14 02:05:30 +08:00
Indices and tables
ADD framework files for ReST content. Includes the documentation license, a substitutions file and a README detailing the new infrastructure and its installation. Updates the master file, index.rst, to accomodate the content files. Change-Id: I529567e6e29d24a4261c0fa4b3db1176266f9777 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-05-16 00:38:34 +08:00
##################
Add tools and Makefiles for Documentation This will allow us to start adding content and structure. To generate documentation you will need to install both - sphinx - breathe go into the doc directory and run: $ make doxy html No content has been submitted here, only a few placeholders. Change-Id: Ifc3617aee8f7d45fa4e4a494ff0a1ab71516af06 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-05-14 02:05:30 +08:00
* :ref:`genindex`
Add Disclaimer explaining that the documentation is a work in progress. The disclaimer was added in a separate file keeping the master file index.rst clean. The master file was only changed to include the disclaimers.rst file. Change-Id: I51a56c64dee3285ea3b9be22f0eab477459d8417 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2015-05-26 01:19:03 +08:00
* :ref:`search`
Fix the index page and headers - Put license at the bottom - Add a title - Change disclaimer from a heading to a rubric Change-Id: I19b73e3a0408fd95efb514e75ea4ee028bb8f50c Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-06-14 03:51:09 +08:00