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

34 lines
498 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
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
|project|
Doc: Add architectural overview of the operating system. 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>
2015-06-23 05:14:06 +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
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::
:maxdepth: 2
Doc: Add architectural overview of the operating system. 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>
2015-06-23 05:14:06 +08:00
architecture/architecture.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
installation/installation.rst
collaboration/collaboration.rst
doc: Add development section Change-Id: I5d5256607d5b6fff2537ce3d3175c8bf90168a73 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-06-20 04:55:13 +08:00
development/index.rst
Add Object Documentation Adds the basic kernel objects' documentation describing the function of tasks, fiber and interrupt service routines. Adds the nanokernel objects' docuementation describing the function of the most important nanokernel objects. Adds the microkernel objects' documentation describing the function of the most important microkernel objects. Changes the index.rst file to include the Object Documentation. Change-Id: Ib35d973cc3575a7ecc32c4ab175e05cb298e3306 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-05-20 23:51:50 +08:00
object/object.rst
Doc: Add Bluetooth basic documentation Add basic Bluetooth documentation with sample. Change-Id: I46077c8ee7e0ef464cda2374056fe061caaaee8b Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
2015-06-11 16:22:15 +08:00
net/network.rst
doc: Initial platform configuration guides 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>
2015-06-20 03:48:34 +08:00
platform/platform.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
doxygen/doxygen.rst
Doc: Add documentation guidelines to master file. The documentation master file index.rst is changed to include the documentation style guide. Change-Id: I5074968d5e1be754c38f599a5220bf9596abd828 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2015-06-24 03:58:32 +08:00
documentation/documentation.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