Skip to content

Commit

Permalink
doc: fix documentation target and instructions
Browse files Browse the repository at this point in the history
Change-Id: I5e42d3ae54ccee74fac7c2074e1d6df5bb2cce92
Signed-off-by: Anas Nashif <[email protected]>
  • Loading branch information
nashif authored and Anas Nashif committed Jan 9, 2017
1 parent d8629bf commit 1e60eff
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions doc/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,21 +62,20 @@ Running the Documentation Generators
************************************

Assuming that the Zephyr Project tree with the doc directory is in
``DIRECTORY``, type:
``<ZEPHYR_BASE>``, type:

.. code-block:: bash
$ cd DIRECTORY/doc
$ cd <ZEPHYR_BASE>
$ make htmldocs
$ make doxy html
Find the output in ``DIRECTORY/doc/_build/html/index.html``
Find the output in ``<ZEPHYR_BASE>/doc/_build/html/index.html``

Review the available formats with:

.. code-block:: bash
$ make -C DIRECTORY/doc doxy html
$ make -C <ZEPHYR_BASE>/doc help
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.
Expand Down

0 comments on commit 1e60eff

Please sign in to comment.