michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Remove Sphinx markup from README

Browse source 
Removes the Sphinx specific ReST Markup from th README.rst file.
This allows basic ReST converters to render the README without
markup showing raw.

Change-Id: I9f31afb953802119939d177524c0d283414c3a48
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
This commit is contained in:
Rodrigo Caballero 2016-01-25 12:06:33 -06:00 • committed by Anas Nashif
commit 40df7fcf41
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/README.rst
View file

@ -26,7 +26,7 @@ The project's documentation currently comprises the following items:
Installing the documentation processors
***************************************
Install the current version of :program:`Sphinx`, type:
Install the current version of ``Sphinx``, type:
.. code-block:: bash
@ -46,14 +46,14 @@ Install the current version of :program:`Sphinx`, type:
.. note::
Make sure that :program:`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.
Running the documentation generators
************************************
Assuming that the Zephyr Project tree with the doc directory is in
:file:`DIRECTORY`, type:
``DIRECTORY``, type:
.. code-block:: bash
@ -61,7 +61,7 @@ Assuming that the Zephyr Project tree with the doc directory is in
$ make doxy html
Find the output in :file:`DIRECTORY/doc/_build/html/index.html`
Find the output in ``DIRECTORY/doc/_build/html/index.html``
Review the available formats with: