Commit Graph

11 Commits

Author SHA1 Message Date
Benjamin Cabé
155420522b doc: Fix occurrences of repeated words
Another round of repeated words cleanup. This commit tries to keep the
diff minimal and line wrapping was mostly left intact in the touched
files, as having them consistent across the documentation is probably
the topic of a future tree-wide cleanup (or not)

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-15 17:34:39 -05:00
Martí Bolívar
1d3b8bd879 doc: west: release notes for v1.2
The main new features are a 'west grep' command and a new
'description:' field in the manifest file's 'projects:' elements.

Rather than try to keep the version number in index.rst up to
date, which it frequently is not, just delete the paragraph.

Signed-off-by: Martí Bolívar <mbolivar@amperecomputing.com>
2023-10-21 13:14:57 +02:00
Andreas Deininger
571f8591b9 documentation: Fix several typos
Correcting typos in various documentation files

Signed-off-by: Andreas Deininger <andreas@deininger.net>
2023-08-07 13:07:50 +02:00
Martí Bolívar
98810bc7a1 doc: west: v1.0.1 and v1.1.0 release notes
Add release notes and update relevant documentation pages
for these releases.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2023-06-04 16:52:20 -07:00
Martí Bolívar
5d72602cc4 doc: west: improve "version:" documentation
Consolidate information from release-notes.rst into
a new table describing the manifest file format features
which were introduced in each version of west.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2023-06-04 16:52:20 -07:00
Martí Bolívar
0de8c6bf29 .github: doc-build: move to west 1.0.0
The release notes are in and west==1.0.0 is installable via pypi.
Move the doc build over to it and fix a typo while we are here.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2023-02-21 19:39:50 +09:00
Martí Bolívar
5e0a6cd076 doc: west: release notes for west v1.0
Document the west v1.0 release, which brings with it stable APIs,
removal of legacy APIs, and other changes.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2023-02-20 13:00:47 -08:00
Martí Bolívar
f3fdfa3ff5 doc: west v0.14 release notes
Document this bug fix release.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2022-08-29 16:54:53 +02:00
Gerard Marull-Paretas
cd739a9757 doc: fix incorrect usage of envvar role
:envvar: is currently used to tag environment variables, however,
:envvar: role expects a matching .. envvar:: directive where the
environment variable is defined. This patch fixes some cases by adding
envvar directives and by converting certain cases to literals (it
doesn't make sense to document all env vars in a list, as some are
self-documented by contextual information).

Ref. https://www.sphinx-doc.org/en/master/usage/restructuredtext/
roles.html#role-envvar

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-08-23 10:15:34 +02:00
Martí Bolívar
d1ae18c342 doc: west 0.13.1 release notes
This is a bug fix point release.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2022-04-24 19:47:33 +02:00
Anas Nashif
3f604746da doc: move west section to developing with zephyr
Move all west docs into the new `developing with zephyr` section.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00