patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 7 Packages Projects Releases Wiki Activity
zephyr/index.rst

62 lines
1.7 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-15 18:38:34 +02: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-13 21:51:09 +02: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-15 18:38:34 +02: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-05 17:06:00 +01: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 17:23:57 +02: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-03 22:07:50 +02: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 17:23:57 +02:00
doc: support official website theme Jira: ZEP-1512 Change-Id: I795b1cdec3eb6096c97e2b97013184914102dccf Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-04 15:39:45 +01:00
.. only:: (development or daily)
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 17:23:57 +02:00
Welcome to the Zephyr Project's documentation. This is the documentation of the
doc: read version from Makefile Change-Id: I6edb5ee53cdff1c687e97663c93ddaa3b09a9288 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-12-23 18:25:06 +01:00
master tree under development (version |version|).
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 17:23:57 +02:00
Documentation for released versions of Zephyr can be found at
doc: add 1.3.0 to documentation list Change-Id: I496b48fffda100bf577680e2abad3b030746e0b5 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-05-28 14:22:40 +02:00
``https://www.zephyrproject.org/doc/<version>``. The following documentation
doc: Create "Introducing Zephyr" document Relocates the introductory material for Zephyr into a new document, so that it can be more easily located by users. (Previously this info couldn't be accessed from the list of documents on the left hand side of a web page; instead, you had to click on the "Documentation" tab at the top of the page, which is non-intuitive.) Change-Id: I1e1f78162a314b958789fcef57fc864336007f3c Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-06-30 17:45:21 +02:00
versions are available:
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 17:23:57 +02:00
doc: add link to 1.6 documentation Change-Id: I124cc64176b1cc5e115e29721066b463cd5df0fd Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-12-03 22:07:31 +01:00
`Zephyr 1.1.0`_ | `Zephyr 1.2.0`_ | `Zephyr 1.3.0`_ | `Zephyr 1.4.0`_ | `Zephyr 1.5.0`_ | `Zephyr 1.6.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-15 18:14:55 +02: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-17 23:04:22 +02: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-13 20:05:30 +02: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 15:14:50 +02: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-13 20:05:30 +02:00
doc: move documetnation context to root directory This will allow inclusion of documentation files that exist outside of doc/ and will make it possible to add rst files across the tree, especially for boards, samples and tests. Change-Id: I7afcf92d99f504b2bc0b2b7e3452acb2f8e08294 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-03 20:38:53 +01:00
doc/introduction/introducing_zephyr.rst
doc/getting_started/getting_started.rst
boards: prepare for integration of board documentation Re-add board documentation and integrate into the project online documentation. Setup sphinx to pick any new board documentation added to boards/*. Change-Id: Id208d5ef923f8806135879dd33a55ed527dc5f27 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-12-25 16:58:23 +01:00
boards/boards.rst
doc: move documetnation context to root directory This will allow inclusion of documentation files that exist outside of doc/ and will make it possible to add rst files across the tree, especially for boards, samples and tests. Change-Id: I7afcf92d99f504b2bc0b2b7e3452acb2f8e08294 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-03 20:38:53 +01:00
doc/kernel/kernel.rst
doc/application/application.rst
doc/porting/porting.rst
doc/drivers/drivers.rst
doc/subsystems/subsystems.rst
doc/api/api.rst
samples/samples.rst
doc/reference/kconfig/index.rst
doc/contribute/code.rst
doc/release-notes.rst
doc/LICENSING.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 15:37:12 +01: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-15 18:14:55 +02:00
You can find further information on the `Zephyr Project Wiki`_.
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-05 17:06:00 +01: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-13 20:05:30 +02: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-25 19:19:03 +02: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-15 18:14:55 +02:00
.. _Zephyr Project Wiki: https://wiki.zephyrproject.org/view/Main_Page
doc: add link to 1.6 documentation Change-Id: I124cc64176b1cc5e115e29721066b463cd5df0fd Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-12-03 22:07:31 +01:00
.. _Zephyr 1.6.0: https://www.zephyrproject.org/doc/1.6.0/
doc: Add 1.5.0 docs link to Zephyr/doc home page Change-Id: I0e15fa11fba8f156359ea0d767efe04702802590 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2016-08-01 18:28:47 +02:00
.. _Zephyr 1.5.0: https://www.zephyrproject.org/doc/1.5.0/
doc: add links for version 1.4.0 documents update index.rst to include 1.4.0 doc folder Change-Id: I57b7ea470e4a5d2f8e93459f90421a87abf331ce Signed-off-by: David Kinder <david.b.kinder@intel.com>
2016-06-21 12:04:06 +02:00
.. _Zephyr 1.4.0: https://www.zephyrproject.org/doc/1.4.0/
doc: add 1.3.0 to documentation list Change-Id: I496b48fffda100bf577680e2abad3b030746e0b5 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-05-28 14:22:40 +02:00
.. _Zephyr 1.3.0: https://www.zephyrproject.org/doc/1.3.0/
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 17:23:57 +02: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/
Reference in a new issue Copy permalink