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

51 lines
627 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-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: 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
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-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: 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
about_zephyr.rst
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-28 17:59:49 +01: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-28 23:27:56 +01:00
kernel/kernel.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 15:14:50 +02:00
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 16:28:24 +02: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 15:14:50 +02:00
application/application.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-01 18:28:50 +01:00
api/api.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 17:57:36 +02: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-15 18:38:34 +02:00
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: 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
Reference 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 16:28:24 +02: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 15:14:50 +02:00
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
Supported Boards
################
.. toctree::
:maxdepth: 2
board/board.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 15:14:50 +02: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`
Reference in a new issue Copy permalink