Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
227 commits
Select commit Hold shift + click to select a range
da1fb89
doc: add initial west documentation
Jun 8, 2018
e045182
scripts: update west to latest upstream version.
Sep 23, 2018
d3c4a8d
scripts: west: Add documentation for the multi-repo commands
ulfalizer Nov 1, 2018
15d0048
doc: restructure documentation
nashif Jan 5, 2019
2bc8413
doc: scripts: Retrieve west path at runtime
carlescufi Nov 12, 2018
bd63ec8
doc: Use west instead of Git to clone Zephyr
carlescufi Nov 12, 2018
fb20545
doc: west: Move files to the correct location
carlescufi Jan 23, 2019
922d4c1
doc: west: Overhaul documentation to match current model
carlescufi Jan 23, 2019
a523c36
scripts: add west build, flash, and debug commands
Jan 23, 2019
810f908
west: Multiple CI fixes for the topic-west branch
carlescufi Jan 25, 2019
42566f7
doc: west: Misc formatting fixes
carlescufi Jan 26, 2019
52bbe2a
doc: west: Do not fail doc build if west not used
carlescufi Jan 27, 2019
ec765b9
doc: incremental improvements to west docs
Jan 30, 2019
5a58f37
doc: without-west.rst: fixes for correctness
Jan 31, 2019
142932e
doc: introduce final structure
nashif Feb 2, 2019
f18b821
doc: west: Document west build
carlescufi Feb 7, 2019
66c6c51
west: commands: build: Specify source dir without a flag
carlescufi Feb 21, 2019
bd4febe
doc: use :zephyr_file: where appropriate
dbkinder Mar 8, 2019
50629d2
doc: Fix typo and markup elements
evil-scientist Mar 14, 2019
c5ec337
doc: fix misspelling in docs and API comments
dbkinder Mar 27, 2019
c0b18bb
doc: west: add missing parts for zephyr v1.14
Feb 13, 2019
bc76ca9
doc: additional clarifications on west
mbolivar-nordic Apr 2, 2019
e9b24d8
doc: add example of how to build MCUBoot app with west
mnkp Apr 4, 2019
015d75f
doc: add missing doc top labels
dbkinder Apr 10, 2019
6b65d3c
west: build: Add new pristine cmd-line and config option
carlescufi Apr 14, 2019
007d1db
scripts: west: Run pristine.cmake directly instead of the target
carlescufi Apr 18, 2019
87ec07f
west: Add a boards command
carlescufi Apr 23, 2019
d379372
scripts: improve west build's board handling
mbolivar-nordic May 4, 2019
0b9b48d
doc: re-word and extend west build documentation
mbolivar-nordic May 1, 2019
0ba8791
scripts: add build.generator config option for west build
mbolivar-nordic May 1, 2019
841b0d7
scripts: make west build -h fit on a screen
mbolivar-nordic May 4, 2019
0dd3df0
doc: fix west boards tip
mbolivar-nordic May 4, 2019
3f38af8
west: Add completion command
carlescufi May 8, 2019
f67b0ab
doc: west: Document west installation in-depth
carlescufi May 8, 2019
928f17c
doc: updates for west installation docs
mbolivar-nordic May 12, 2019
651f97d
doc: updates to west multi-repo docs
mbolivar-nordic May 12, 2019
001027e
doc: move sign command docs before catch-all page
mbolivar-nordic May 12, 2019
aa680ab
doc: move module related doc to guides
nashif May 10, 2019
6745196
west: build: Configurable build folder format
carlescufi Jun 5, 2019
78111cb
docs: update west sign docs
mbolivar-nordic Jun 13, 2019
9fc2d63
west: runners: Guess build folder
carlescufi Jun 17, 2019
909042d
doc: Consolidate Python and pip documentation
carlescufi Jul 25, 2019
978be27
doc: add a release notes page for west
mbolivar-nordic Jun 13, 2019
5a755fe
doc: move runner documentation out of west-apis.rst
mbolivar-nordic Jul 22, 2019
43eed31
west: require v0.6.0 or higher
mbolivar-nordic Jul 22, 2019
a0ea311
doc: west: Fix west completion docs
carlescufi Aug 12, 2019
e784f48
doc: west: add some missing information
mbolivar-nordic Aug 28, 2019
bfc3b96
doc: west: add v0.6.1 documentation
mbolivar-nordic Aug 28, 2019
3d62ef6
doc: west: add tl;dr for moving to west and troubleshooting
mbolivar-nordic Aug 28, 2019
0047241
doc: west: v0.6.2 fixes a critical v0.6.1 bug
mbolivar-nordic Sep 4, 2019
85d647d
doc: add more cross-references/examples for DT overlays
mbolivar-nordic Oct 4, 2019
9d16549
doc: s/device tree/devicetree/
mbolivar-nordic Oct 7, 2019
e64510a
doc: west fixes and updates to manifest.rst
mbolivar-nordic Oct 7, 2019
40c752e
scripts: add new west build "build.cmake-args" config option
mbolivar-nordic Dec 9, 2019
4c0bee0
global: Remove leading/trailing blank lines in files
ulfalizer Nov 18, 2019
6cdc3f7
doc: west: move manifest command docs to manifest.rst
mbolivar-nordic Apr 3, 2019
5ca9597
doc: west: add docs for west manifest --validate
mbolivar-nordic Oct 10, 2019
e90fa87
doc: west: add "git." prefix to URL hosts
mbolivar-nordic Oct 7, 2019
f587b55
doc: west: document manifest import feature
mbolivar-nordic Oct 7, 2019
54e9c9b
doc: west: 0.7.0 documentation
mbolivar-nordic Oct 11, 2019
9163bb0
doc: split devicetree docs into multiple pages
mbolivar-nordic Feb 18, 2020
a45e58d
doc: west: add examples for each topology
mbolivar-nordic Feb 24, 2020
cb546e7
doc: west: update structure page
mbolivar-nordic Feb 24, 2020
1e662b2
doc: west: 'west installation' is now 'west workspace'
mbolivar-nordic Feb 24, 2020
6101d3f
doc: more board porting improvements
mbolivar-nordic Mar 4, 2020
f75dfa6
doc: dts: revisit documentation
mbolivar-nordic Mar 11, 2020
7da6475
doc: west: add pointer to board porting guide for flash/debug
mbolivar-nordic Mar 17, 2020
a345ec9
doc: west: add FAQ for missing extension command
mbolivar-nordic Mar 31, 2020
3a4ccec
doc: west: add FAQ for requires_workspace issue #373
mbolivar-nordic Mar 31, 2020
7475694
doc: west: link to modules page instead of source code
mbolivar-nordic Apr 7, 2020
5ec755e
doc: west: troubleshoot no west on PATH on windows
mbolivar-nordic Aug 18, 2020
96a6f57
doc: west: update west sign documentation
mbolivar-nordic Aug 31, 2020
c0f497b
doc: west: add information about private repositories
mbolivar-nordic Sep 17, 2020
122dd3f
doc: west: add missing 0.7.x docs
mbolivar-nordic Sep 9, 2020
d45fa42
doc: west: API doc cleanups
mbolivar-nordic Sep 9, 2020
8c47e47
doc: west: changes for v0.8
mbolivar-nordic Sep 9, 2020
54447c7
doc: west: fix typo in release notes
mbolivar-nordic Oct 6, 2020
707891f
doc: update west build --pristine
mbolivar-nordic Oct 7, 2020
7b71fc4
doc: west: add inline comments in the tree and manifest examples
marc-hb Oct 8, 2020
2d8ae10
doc: guides: debugging: Move to flash_debug dir
nandojve Nov 6, 2020
e38b7d8
doc: improve west's repo-tool.rst
mbolivar-nordic Jan 6, 2021
1fde6a7
doc: west: add note about west update --keep-descendants option
marc-hb Jan 9, 2021
539ccb6
doc: west: Fix config overrides
carlescufi Jan 26, 2021
352eac6
doc: west update can create loose commits
mbolivar-nordic Jan 11, 2021
56ecd5d
doc: west: add manifest.file config option
mbolivar-nordic Jan 13, 2021
2708beb
doc: re-work west update to prep for new features
mbolivar-nordic Jan 12, 2021
bd0595f
doc: west has moved to allowlist/blocklist
mbolivar-nordic Jan 7, 2021
77c822a
doc: west: add project groups
mbolivar-nordic Jan 21, 2021
e3cede8
doc: west: add submodules
mbolivar-nordic Jan 12, 2021
701b8a2
doc: west: update schema version
mbolivar-nordic Jan 12, 2021
59a48d5
doc: west: API changes for 0.9.0
mbolivar-nordic Jan 12, 2021
393942f
doc: west: release notes for 0.9.0
mbolivar-nordic Jan 7, 2021
d432bd7
doc: west reserves refs/west/
mbolivar-nordic Jan 14, 2021
22f8ed0
doc: clean up west index
mbolivar-nordic Feb 6, 2021
27eee19
doc: west: move advanced content out of 'basics'
mbolivar-nordic Feb 6, 2021
570086d
doc: update west's workspaces.rst for 2.5
mbolivar-nordic Feb 6, 2021
672ad03
doc: add missing docs for 'west zephyr-export'
mbolivar-nordic Feb 6, 2021
6a97b9b
doc: improve manifest key docs
mbolivar-nordic Feb 7, 2021
630a7c8
doc: improve docs on building without west
mbolivar-nordic Feb 7, 2021
4a0d2b0
doc: west: clean up example workspace
mbolivar-nordic Feb 8, 2021
3214ab8
doc: west: improve troubleshooting for west update
mbolivar-nordic Feb 10, 2021
9d3b022
doc: west: make it clearer how to override the default runner
mbolivar-nordic Feb 22, 2021
ebd6335
doc: west: move 'manifest imports' to bottom of manifest.rst
mbolivar-nordic Feb 16, 2021
decfe37
doc: west: fix incorrect docs related to imports
mbolivar-nordic Feb 16, 2021
50a8d41
doc: west: clean up manifest import details
mbolivar-nordic Feb 16, 2021
4ae83e9
doc: west: document west 0.10 group-filter + import behavior
mbolivar-nordic Feb 17, 2021
ad437c6
doc: west: projects list is optional in v0.10
mbolivar-nordic Mar 1, 2021
741700d
doc: west: touch up remotes documentation
mbolivar-nordic Mar 1, 2021
10d30be
doc: west: submodule 'name' is optional after west 0.9.0
marc-hb Feb 9, 2021
a9accf6
doc: west: bump 'manifest: version:' docs
mbolivar-nordic Mar 1, 2021
649c296
doc: west: 0.10.0 and 0.9.1 release notes
mbolivar-nordic Mar 1, 2021
312c831
doc: west: remove some unnecessary 'master' usages
mbolivar-nordic Mar 15, 2021
c211651
doc: west: west init --mr changes for v0.10.1
mbolivar-nordic Mar 15, 2021
388979f
doc: west: fix submodule update info
mbolivar-nordic Apr 6, 2021
b651ee8
doc: west: add 0.11.0 docs
mbolivar-nordic May 4, 2021
85a6f02
doc: add docs for west spdx
mbolivar-nordic May 27, 2021
4871c7c
doc: release-notes-2.6: west extensions
mbolivar-nordic May 27, 2021
d02dbe5
doc: use kconfig role and directive
gmarull Jun 28, 2021
8680047
doc: west build: examples for -o and how to use -jN
mbolivar-nordic Jul 30, 2021
fdb9fd3
doc: west v0.11.1 notes
mbolivar-nordic Aug 6, 2021
31ccbfa
doc: west release 0.11.1 follow-ups
mbolivar-nordic Aug 10, 2021
8d3ec5e
doc: west 0.12 docs
mbolivar-nordic Nov 4, 2021
4d5295d
doc: west: build-flash-debug: fix cmake arg example
bbilas Nov 16, 2021
b752a85
doc: drop single quote references
gmarull Dec 10, 2021
fb3df61
doc: use extlink for github issue links
henrikbrixandersen Jan 17, 2022
d0ffe71
doc: fix PDF build issue due to extlink references
gmarull Jan 17, 2022
b35b7b6
doc: use :kconfig:option: domain role
gmarull Feb 7, 2022
8809ed3
everywhere: fix typos
nazar01 Mar 16, 2022
6fba946
doc: Fix west spdx command docs formatting bug
swinslow Mar 19, 2022
a955e37
doc: west: Add mention about Git rewrite feature
finikorg Mar 22, 2022
60f8b8f
doc: west: v0.13.0 docs
mbolivar-nordic Apr 4, 2022
7479c5a
doc: move west section to developing with zephyr
nashif Apr 5, 2022
b62fd2e
doc: Fix spelling errors in .rst files
amarkovicsa Apr 13, 2022
f972812
doc: west 0.13.1 release notes
mbolivar-nordic Apr 20, 2022
889295e
doc: west: Add an example of using the credential store for GitHub
carlescufi Apr 26, 2022
80f4b61
doc: drop few reference of -s west build flag
fabiobaltieri Jul 9, 2022
73f6d7b
doc: sysbuild documentation guide
tejlmand Mar 14, 2022
d8ae41f
blobs: Document the command and the module integration
carlescufi Aug 16, 2022
3865eca
doc: west: mention west blobs in without-west.rst
mbolivar-nordic Aug 19, 2022
5b60f76
doc: fix incorrect usage of envvar role
gmarull Aug 19, 2022
affe553
doc: west v0.14 release notes
mbolivar-nordic Aug 29, 2022
deef8a6
doc: west: Document the 'west completion' command
carlescufi Sep 6, 2022
3c09b24
doc: manifest.rst: Describe using 'revision: HEAD~0' in manifests
oyvindronningstad Sep 9, 2022
1b34700
doc: west: Update outdated link to SPDX specification
stephanosio Sep 28, 2022
25a82d9
tinycbor: Remove deprecated/obsolete module
nordicjm Jan 9, 2023
072b0b6
west: Update documentation on twister script integration
asemjonovs Sep 26, 2022
95605bf
doc: west: improve 'manifest --validate' section
mbolivar-nordic Jan 20, 2023
71a6d21
doc: west: release notes for west v1.0
mbolivar-nordic Feb 17, 2023
89b7c1a
.github: doc-build: move to west 1.0.0
mbolivar-nordic Feb 20, 2023
9781147
doc: west: fix WestCommand self.configuration -> self.config
marc-hb Mar 12, 2023
4351968
doc: add snippets documentation
mbolivar-nordic Jan 9, 2023
abc1aca
doc: develop: west: sign: Add details on extending signing
nordicjm Mar 24, 2023
dd5c0db
intel_adsp: move `west sign` from `west flash` to earlier `west build`
marc-hb Feb 24, 2023
5bf36ae
docs/build-flash-debug: expand one-time CMake arguments section
marc-hb Apr 8, 2023
0140e3a
doc: modules: Clarify the difference between modules and projects
carlescufi Apr 5, 2023
c9be678
doc: west: apis: fix MalformedConfig autoclass
mbolivar-nordic May 19, 2023
3e9c0f0
doc: introduce EXTRA_CONF_FILE and EXTRA_DTC_OVERLAY_FILE
tejlmand May 17, 2023
fc7f375
doc: west: clarify import example YAML
mbolivar-nordic May 23, 2023
1426c6f
doc: west: improve "version:" documentation
mbolivar-nordic May 23, 2023
c2bd18c
doc: west: troubleshooting: fix path
mbolivar-nordic May 31, 2023
13217f2
doc: west: fix group filter documentation
mbolivar-nordic Jun 1, 2023
b216752
doc: west: v1.0.1 and v1.1.0 release notes
mbolivar-nordic Jun 2, 2023
bad97f5
west: doc: update link to SPDX doc
kartben Jun 6, 2023
aedc275
documentation: Fix several typos
deining Aug 3, 2023
369d11e
west: sign: do not make rimage configuration and platform name mandatory
iuliana-prodan Aug 22, 2023
3635273
doc: west: Remove empty Footnotes rubric
finikorg Aug 15, 2023
bf969ef
doc: Migrate subsys/ code samples to new Sphinx extension
kartben Sep 6, 2023
3a62ece
doc: bindesc: Add documentation for binary descriptors
yonsch Mar 25, 2023
a28d395
doc: west: build: fix info on --pristine default
mbolivar-ampere Oct 11, 2023
88718b2
doc: west: sort built-in project commands by name
mbolivar-ampere Oct 6, 2023
1c77033
doc: west: add docs for west grep
mbolivar-ampere Oct 6, 2023
d9146a9
doc: west: sort west.manifest.Project info by release
mbolivar-ampere Oct 6, 2023
028abd9
doc: west: manifest file format changes for v1.2
mbolivar-ampere Oct 6, 2023
4049200
doc: west: API changes for v1.2
mbolivar-ampere Oct 6, 2023
e0e56ab
doc: west: release notes for v1.2
mbolivar-ampere Oct 6, 2023
ed93093
doc: Fix double 'the'
butok Nov 15, 2023
ee6ea43
doc: Fix occurrences of repeated words
kartben Nov 15, 2023
a8fb599
scripts: zspdx: Include modules as packages in zephyr.spdx
tgagneret-embedded Dec 5, 2023
2d84071
doc: develop: fix typo
ndrs-pst Jan 25, 2024
2fba820
doc: develop: west: sign: Add details on signing
nordicjm Jan 29, 2024
fb8c07b
Documentation: Update shell completion doc
Emplis Sep 18, 2023
f167887
west: spdx: introduce support for SPDX 2.3
kartben Mar 21, 2024
5b122d7
West: Add `west simulate` command
mszprejda Mar 7, 2024
78ca372
West: Add `west robot` command
mszprejda Mar 7, 2024
65bb96f
scripts: zephyr_module: Add URL, version to SPDX
tgagneret-embedded Jan 18, 2024
843422a
doc: west: Clarify basic west terms
carlescufi Jun 25, 2024
e3628db
doc: fix typo in multiple directories before v3.7.0 release
ndrs-pst Jul 6, 2024
9f7fb3e
tools: net-tools: place net-tools inside tools
fg-cfh Sep 2, 2024
7de2643
doc: sphinx-lint: fix unbalanced-inline-literals-delimiters
kartben Sep 10, 2024
98baf29
doc: sphinx-lint: fix bad usage of "default role"
kartben Sep 10, 2024
980623b
samples: hello_world: use zephyr:code-sample directive
kartben Sep 11, 2024
9f2fb6e
doc: build: Add signing page
nordicjm Sep 26, 2024
6054d99
west: bindesc: Added get_offset command
yonsch Dec 20, 2023
515dcf8
doc: sign: minor rimage update following imgtool removal
marc-hb Oct 18, 2024
5689990
boards: qemu: adopt new zephyr:board directive and role
kartben Oct 21, 2024
7df6649
doc: develop: west: Add alias documentation
pdgendt Jul 17, 2024
bb021e1
doc: develop: west: Remove deprecated west.log
pdgendt Sep 29, 2024
1f960cc
doc: develop: Add external runners for modules information
pdgendt Dec 19, 2024
4851645
doc: the west workspace topdir is not a git repository
mbolivar Jan 21, 2025
b5b332e
doc: document "west gtags" command
mbolivar Feb 19, 2025
8c0e42f
scripts: west_commands: Add powershell autocompletion (west -b)
Apr 12, 2025
3503e5d
doc: sbom cmd more detail for build_dir
tobiwan88 Apr 16, 2025
fd89fcf
doc: west: add documentation for west patch
cfriedt May 9, 2025
8138d60
doc: develop: west: Update release notes
pdgendt May 15, 2025
6316820
doc: develop: west: Update west API for v1.4.0
pdgendt May 16, 2025
af53eee
doc: west: releases: Fix typo
carlescufi May 23, 2025
b7bb1c9
west: spdx: allow to generate for different SPDX versions
kartben May 28, 2025
262b30f
doc: develop: west: document spdx not being supported for native_sim
kartben Jun 17, 2025
41d8774
scripts: west: spdx: extract copyright info
kartben Jun 11, 2025
59dd49c
doc: sign: Describe usage of silabs_commander tool
jerome-pouiller Jun 25, 2025
d533b11
docs: update https links
str4t0m Jul 28, 2025
46fea6d
doc: develop: west: alias: add example for auto-excluding platforms
henrikbrixandersen Aug 31, 2025
a2f21ed
west: blobs: fetch `--allow-regex` filter
noahp Aug 29, 2025
ef487e0
doc: west: remove old west 0.6 and 0.7 related troubleshooting entries
kartben Sep 18, 2025
7bfbcf7
doc: west: drop "Moving to West" doc page
kartben Sep 18, 2025
96eee9c
doc: develop: west: Add v1.5.0 release notes
pdgendt Sep 20, 2025
be21359
doc: develop: west: config: Add auto-cache
pdgendt Sep 23, 2025
5e93683
scripts: flash: Add west config for flash skip rebuild
decsny Sep 16, 2025
405d94e
west: bindesc: add extract subcommand
pillo79 Oct 20, 2025
7a0d0a3
doc: develop: west: config option build.dir-fmt
thorsten-klein Oct 24, 2025
0874a58
pyproject.toml: Add docs group with sphinx
pdgendt Oct 1, 2025
1f48927
doc: Move west to top-level doc/ directory
pdgendt Nov 6, 2025
fbabc44
Merge branch 'west-docs' of zephyr into docs
pdgendt Nov 6, 2025
de3dd53
doc: Remove Zephyr specific files
pdgendt Nov 6, 2025
4e6bf64
doc: Add sphinx conf.py and static resources
pdgendt Nov 6, 2025
62f61a3
doc: West specific modifications
pdgendt Oct 2, 2025
bbbf70d
ci: Add documentation workflow
pdgendt Oct 8, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Build documentation

on: [push, pull_request]

permissions:
contents: read

# Cancel ongoing builds on new changes
concurrency:
group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.head_ref || github.ref }}
cancel-in-progress: true

jobs:
build:
name: Run tasks
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
persist-credentials: false

- name: Set up Python
uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
with:
python-version: "3.14"

- name: Install uv
uses: astral-sh/setup-uv@b75a909f75acd358c2196fb9a5f1299a9a8868a4 # v6.7.0
with:
enable-cache: true

- name: Install dependencies
run: uv sync --frozen --group docs

- name: Build documentation
run: uv run poe build-docs

- name: Upload artifacts
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
with:
path: doc/_build
include-hidden-files: true
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ htmlcov/
.dir-locals.el
.venv/
junit.xml
doc/_build/
Loading