Commit graph

11 commits

Author SHA1 Message Date
Benjamin Cabé
d30ec30a85 doc: guides: Update PDF output path
The zephyr.pdf file is to be found in _build/latex folder, not
_build/pdf.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-22 14:38:12 +01:00
Keith Short
abf26affe0 doc: Add instructions for installing Python dependencies
The Python dependencies specific to building the documentation were
recently removed from the common requirements. Point users to the
documentation generation instructions and provide details on installing
the doc specific dependencies.

Signed-off-by: Keith Short <keithshort@google.com>
2023-09-06 15:16:38 +02:00
Benjamin Cabé
b667c2cd7e Revert "doc: Replace instances of 'Breathe' with 'Docleaf'"
This reverts commit 10cb87dc2b.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-08-24 09:19:37 +01:00
Gerard Marull-Paretas
7f9215da0e doc: move requirements to doc/
Zephyr scripts do not require documentation dependencies, so let's
move them from scripts/ to doc/.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-07-12 09:13:49 -04:00
Michael Jones
10cb87dc2b doc: Replace instances of 'Breathe' with 'Docleaf'
Where valid.

Signed-off-by: Michael Jones <m.pricejones@gmail.com>
2023-07-03 10:05:52 +00:00
Keith Short
767972355f docs: Make 100 column limit for code explicit
Zephyr's coding style is based on the Linux kernel coding style, which
indicates a preferred limit of 80 columns. Zephyr's .clang-format sets
the ColumnLimit to 100. Update the documentation to match the
.clang-format parameters.

Signed-off-by: Keith Short <keithshort@google.com>
2023-02-21 13:05:54 -05:00
Stephanos Ioannidis
14539ed2e8 doc: documentation: Fix incorrect doc/Makefile reference
This commit fixes the incorrect reference to the `doc/Makefile` and
updates the text to better integrate the reference.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Stephanos Ioannidis
4811575616 doc: documentation: Fix internal linking description
This commit fixes incorrect depiction of the internal link with custom
text usage.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Stephanos Ioannidis
a811d3889b doc: documentation: Update outdated file paths
This commit updates the documentation guidelines to reflect the
refactored documentation paths.

It also corrects the unnecessary escapes of the backticks.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2022-09-29 12:20:14 +02:00
Anas Nashif
121bc3c97d doc: consolidate documentation sections
Consolidate all content realted to documentation.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00
Anas Nashif
20aa90d26c doc: move documentation guidelines
Move documentation guidelines under contribution guidelines.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-06-11 08:50:39 -04:00