Commit Graph

6 Commits

Author SHA1 Message Date
Anas Nashif 8b749c4cfe doc: Add development section
Change-Id: I5d5256607d5b6fff2537ce3d3175c8bf90168a73

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:14:25 -05:00
Anas Nashif 5a7de14ffd 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>
2016-02-05 20:14:21 -05:00
Rodrigo Caballero 56b092d1d5 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>
2016-02-05 20:14:11 -05:00
Rodrigo Caballero 67405bb918 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>
2016-02-05 20:14:11 -05:00
Rodrigo Caballero a4a50fa2d9 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>
2016-02-05 20:14:00 -05:00
Anas Nashif 06d380c2ba 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>
2016-02-05 20:13:58 -05:00