michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Change link in README to external link.

Browse source 
Changed the link to the ReST documentation to a external link for reusability.

Change-Id: Ia575717c0fb92672828bb11854c9a8a1268af464
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
This commit is contained in:
Rodrigo Caballero 2015-12-08 14:30:34 -06:00 • committed by Anas Nashif
commit c0871e4b91
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
doc/README.rst
View file

@ -2,8 +2,8 @@ Welcome to Zephyr Kernel
######################## ########################
.. This document is in Restructured Text Format. .. This document is in Restructured Text Format.
Find more information regarding the ReST markup in the
More information at `<http://sphinx-doc.org/rest.html>`_. `ReST documentation`_.
This is a comment that won't show up in formatted output This is a comment that won't show up in formatted output
Welcome to the Zephyr Project. Welcome to the Zephyr Project.
@ -11,7 +11,6 @@ Welcome to the Zephyr Project.
Thank you for your interest in the Zephyr Project. These instructions are Thank you for your interest in the Zephyr Project. These instructions are
designed to walk you through generating the Zephyr Project's documentation. designed to walk you through generating the Zephyr Project's documentation.
Documentation Notes Documentation Notes
******************* *******************
@ -49,7 +48,7 @@ Install the current version of ``Sphinx``, type:
Make sure that ``Doxygen`` is installed in your system. Make sure that ``Doxygen`` is installed in your system.
The installation of Doxygen is beyond the scope of this document. The installation of Doxygen is beyond the scope of this document.
Running the documentation generators Running the Documentation Generators
************************************ ************************************
Assuming that the Zephyr Project tree with the doc directory is in Assuming that the Zephyr Project tree with the doc directory is in
@ -71,3 +70,5 @@ Review the available formats with:
If you want the LaTeX PDF output, you need to install all the Latex If you want the LaTeX PDF output, you need to install all the Latex
packages first. That installation is beyond the scope of this document. packages first. That installation is beyond the scope of this document.
.. _ReST documentation: http://sphinx-doc.org/rest.html