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

40 lines
561 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
doc: Restore main index and cleanup 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>
2015-08-29 21:14:50 +08:00
Getting Started
###############
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>
2015-08-18 05:04:22 +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: Restore main index and cleanup 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>
2015-08-29 21:14:50 +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: Restore main index and cleanup 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>
2015-08-29 21:14:50 +08:00
about_zephyr.rst
kernel/kernel.rst
quick_start/quick_start.rst
Developer Guides
################
.. toctree::
:maxdepth: 1
doc: fixed inclusion of files to avoid warnings Change-Id: I454a998851f3546f98601ff3b24770e32cf3b268 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-20 22:28:24 +08:00
reference/kbuild/kbuild.rst
doc: Restore main index and cleanup 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>
2015-08-29 21:14:50 +08:00
application/application.rst
platform/platform.rst
Doc: Updates the master files to reflect the new structure. 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>
2015-08-17 23:57:36 +08:00
collaboration/collaboration
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: Restore main index and cleanup 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>
2015-08-29 21:14:50 +08:00
Reference Guides
################
.. toctree::
:maxdepth: 1
reference/api.rst
doc: fixed inclusion of files to avoid warnings Change-Id: I454a998851f3546f98601ff3b24770e32cf3b268 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-20 22:28:24 +08:00
reference/kconfig/index.rst
doc: Restore main index and cleanup 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>
2015-08-29 21:14:50 +08:00
Indices and tables
##################
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`