From 3ba4b6f95b10909975f245db3eabd896ecdd458c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Thu, 5 Oct 2023 12:28:47 +0200 Subject: [PATCH] doc: Improve documentation guidelines intro MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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é --- doc/contribute/documentation/guidelines.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/doc/contribute/documentation/guidelines.rst b/doc/contribute/documentation/guidelines.rst index 20ca94e2948..a98fa751916 100644 --- a/doc/contribute/documentation/guidelines.rst +++ b/doc/contribute/documentation/guidelines.rst @@ -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 ` 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.