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

56 lines
1.3 KiB
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: Fix headings in master index file. 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>
2016-02-06 00:06:00 +08:00
Zephyr Project Documentation
############################
doc: show information about documentation current version 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>
2016-04-21 23:23:57 +08:00
.. only:: release
Welcome to the Zephyr Project's documentation version |version|!
Documentation for the development branch of Zephyr can be found at
doc: Fixed broken link to development documentation 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>
2016-05-04 04:07:50 +08:00
https://www.zephyrproject.org/doc/
doc: show information about documentation current version 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>
2016-04-21 23:23:57 +08:00
.. only:: development
Welcome to the Zephyr Project's documentation. This is the documentation of the
master tree under development.
Documentation for released versions of Zephyr can be found at
``https://www.zephyrproject.org/doc/<version>``, for example:
* Documentation for `Zephyr 1.2.0`_
* Documentation for `Zephyr 1.1.0`_
doc: Modify the master file to a single ToC. - 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>
2016-04-16 00:14:55 +08:00
Sections
********
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: Refactor the Quick Start Guide. 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>
2016-01-29 00:59:49 +08:00
getting_started/getting_started.rst
doc: Fix cross-reference and toctree on index.rst and about_zephyr.rst Change-Id: I315a4d90dc2c98062ca84ec01f915bf47d6f15c1 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-01-29 06:27:56 +08:00
kernel/kernel.rst
doc: Restructure top level sections. Restructures the top level sections to ease finding information. Change-Id: I09de0a0d665fc77dea92797be8ef29970fe8a393 Jira: ZEP-245 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-05-16 22:33:57 +08:00
contribute/code.rst
doc: move device driver to a new section Put all device drivers and device model documentation into one section. Change-Id: Iba6a50796b02b7f9234c23dca706be62fd7b4259 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-28 05:31:44 +08:00
drivers/drivers.rst
doc: create subsystem section 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>
2016-04-09 04:30:16 +08:00
subsystems/subsystems.rst
doc: add architecture porting guide 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>
2016-04-14 08:33:44 +08:00
porting/porting.rst
doc: API documentation refactoring. 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>
2016-02-02 01:28:50 +08:00
api/api.rst
doc: nav for supported boards simplified 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>
2016-02-03 22:37:12 +08:00
board/board.rst
doc: Restructure top level sections. Restructures the top level sections to ease finding information. Change-Id: I09de0a0d665fc77dea92797be8ef29970fe8a393 Jira: ZEP-245 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-05-16 22:33:57 +08:00
reference/kbuild/kbuild.rst
application/application.rst
doc: nav for supported boards simplified 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>
2016-02-03 22:37:12 +08:00
doc: Modify the master file to a single ToC. - 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>
2016-04-16 00:14:55 +08:00
You can find further information on the `Zephyr Project Wiki`_.
doc: Restructure top level sections. Restructures the top level sections to ease finding information. Change-Id: I09de0a0d665fc77dea92797be8ef29970fe8a393 Jira: ZEP-245 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-05-16 22:33:57 +08:00
.. include:: about_zephyr.rst
doc: Fix headings in master index file. 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>
2016-02-06 00:06:00 +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`
doc: Modify the master file to a single ToC. - 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>
2016-04-16 00:14:55 +08:00
.. _Zephyr Project Wiki: https://wiki.zephyrproject.org/view/Main_Page
doc: show information about documentation current version 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>
2016-04-21 23:23:57 +08:00
.. _Zephyr 1.2.0: https://www.zephyrproject.org/doc/1.2.0/
.. _Zephyr 1.1.0: https://www.zephyrproject.org/doc/1.1.0/