doc: Improve documentation guidelines intro
The intro of this document was starting to show its age. Simplified some of the wording and added a reference to the documentation build instructions. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
parent
9e8d609b5d
commit
3ba4b6f95b
1 changed files with 4 additions and 5 deletions
|
@ -11,11 +11,10 @@ Zephyr Project content is written using the `reStructuredText`_ markup
|
|||
language (.rst file extension) with Sphinx extensions, and processed
|
||||
using Sphinx to create a formatted standalone website. Developers can
|
||||
view this content either in its raw form as .rst markup files, or (with
|
||||
Sphinx installed) they can build the documentation using the Makefile
|
||||
on Linux systems, or make.bat on Windows, to
|
||||
generate the HTML content. The HTML content can then be viewed using a
|
||||
web browser. This same .rst content is also fed into the
|
||||
`Zephyr documentation`_ website (with a different theme applied).
|
||||
Sphinx installed) they can :ref:`build the documentation <zephyr_doc>` locally
|
||||
to generate the documentation in HTML or PDF format. The HTML content can
|
||||
then be viewed using a web browser. This same .rst content is served by the
|
||||
`Zephyr documentation`_ website.
|
||||
|
||||
You can read details about `reStructuredText`_
|
||||
and about `Sphinx extensions`_ from their respective websites.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue