Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
226 commits
Select commit Hold shift + click to select a range
d844d59
pyproject.toml: Add docs group with sphinx
pdgendt Oct 1, 2025
5bf73d6
doc: add initial west documentation
Jun 8, 2018
f3bb2f1
scripts: update west to latest upstream version.
Sep 23, 2018
39ddbd4
scripts: west: Add documentation for the multi-repo commands
ulfalizer Nov 1, 2018
e0ab14a
doc: restructure documentation
nashif Jan 5, 2019
39e6709
doc: scripts: Retrieve west path at runtime
carlescufi Nov 12, 2018
c4b5e33
doc: Use west instead of Git to clone Zephyr
carlescufi Nov 12, 2018
ff3ec87
doc: west: Move files to the correct location
carlescufi Jan 23, 2019
ece7f3d
doc: west: Overhaul documentation to match current model
carlescufi Jan 23, 2019
2d1c9bd
scripts: add west build, flash, and debug commands
Jan 23, 2019
f7179fe
west: Multiple CI fixes for the topic-west branch
carlescufi Jan 25, 2019
31a6116
doc: west: Misc formatting fixes
carlescufi Jan 26, 2019
7d4b3c9
doc: west: Do not fail doc build if west not used
carlescufi Jan 27, 2019
dfe632d
doc: incremental improvements to west docs
Jan 30, 2019
51d1a84
doc: without-west.rst: fixes for correctness
Jan 31, 2019
680b639
doc: introduce final structure
nashif Feb 2, 2019
4530012
doc: west: Document west build
carlescufi Feb 7, 2019
7266dd7
west: commands: build: Specify source dir without a flag
carlescufi Feb 21, 2019
b3b56f7
doc: use :zephyr_file: where appropriate
dbkinder Mar 8, 2019
103ba28
doc: Fix typo and markup elements
evil-scientist Mar 14, 2019
a12359e
doc: fix misspelling in docs and API comments
dbkinder Mar 27, 2019
6ac9ac2
doc: west: add missing parts for zephyr v1.14
Feb 13, 2019
dd2b16e
doc: additional clarifications on west
mbolivar-nordic Apr 2, 2019
a579e77
doc: add example of how to build MCUBoot app with west
mnkp Apr 4, 2019
1cad5df
doc: add missing doc top labels
dbkinder Apr 10, 2019
bc4705d
west: build: Add new pristine cmd-line and config option
carlescufi Apr 14, 2019
ea6f6bf
scripts: west: Run pristine.cmake directly instead of the target
carlescufi Apr 18, 2019
0a96aad
west: Add a boards command
carlescufi Apr 23, 2019
cee567a
scripts: improve west build's board handling
mbolivar-nordic May 4, 2019
c4f5e1b
doc: re-word and extend west build documentation
mbolivar-nordic May 1, 2019
aeb5d41
scripts: add build.generator config option for west build
mbolivar-nordic May 1, 2019
2223bc5
scripts: make west build -h fit on a screen
mbolivar-nordic May 4, 2019
6da6aef
doc: fix west boards tip
mbolivar-nordic May 4, 2019
e034054
west: Add completion command
carlescufi May 8, 2019
da65db6
doc: west: Document west installation in-depth
carlescufi May 8, 2019
46cd600
doc: updates for west installation docs
mbolivar-nordic May 12, 2019
6c7092f
doc: updates to west multi-repo docs
mbolivar-nordic May 12, 2019
651c38e
doc: move sign command docs before catch-all page
mbolivar-nordic May 12, 2019
4f291a3
doc: move module related doc to guides
nashif May 10, 2019
ba2bda7
west: build: Configurable build folder format
carlescufi Jun 5, 2019
13dc065
docs: update west sign docs
mbolivar-nordic Jun 13, 2019
fd69cc1
west: runners: Guess build folder
carlescufi Jun 17, 2019
cc493f0
doc: Consolidate Python and pip documentation
carlescufi Jul 25, 2019
ab09938
doc: add a release notes page for west
mbolivar-nordic Jun 13, 2019
1ae3988
doc: move runner documentation out of west-apis.rst
mbolivar-nordic Jul 22, 2019
a9bced6
west: require v0.6.0 or higher
mbolivar-nordic Jul 22, 2019
e1ead0a
doc: west: Fix west completion docs
carlescufi Aug 12, 2019
074552e
doc: west: add some missing information
mbolivar-nordic Aug 28, 2019
05924f3
doc: west: add v0.6.1 documentation
mbolivar-nordic Aug 28, 2019
0b7c9d1
doc: west: add tl;dr for moving to west and troubleshooting
mbolivar-nordic Aug 28, 2019
c7c1b7f
doc: west: v0.6.2 fixes a critical v0.6.1 bug
mbolivar-nordic Sep 4, 2019
e731954
doc: add more cross-references/examples for DT overlays
mbolivar-nordic Oct 4, 2019
104bf58
doc: s/device tree/devicetree/
mbolivar-nordic Oct 7, 2019
2e40c3b
doc: west fixes and updates to manifest.rst
mbolivar-nordic Oct 7, 2019
f14734a
scripts: add new west build "build.cmake-args" config option
mbolivar-nordic Dec 9, 2019
21e9096
global: Remove leading/trailing blank lines in files
ulfalizer Nov 18, 2019
443bae0
doc: west: move manifest command docs to manifest.rst
mbolivar-nordic Apr 3, 2019
7985993
doc: west: add docs for west manifest --validate
mbolivar-nordic Oct 10, 2019
8021a39
doc: west: add "git." prefix to URL hosts
mbolivar-nordic Oct 7, 2019
360c471
doc: west: document manifest import feature
mbolivar-nordic Oct 7, 2019
0881982
doc: west: 0.7.0 documentation
mbolivar-nordic Oct 11, 2019
597d015
doc: split devicetree docs into multiple pages
mbolivar-nordic Feb 18, 2020
e0d51a9
doc: west: add examples for each topology
mbolivar-nordic Feb 24, 2020
237fc34
doc: west: update structure page
mbolivar-nordic Feb 24, 2020
dcbad66
doc: west: 'west installation' is now 'west workspace'
mbolivar-nordic Feb 24, 2020
a1596e6
doc: more board porting improvements
mbolivar-nordic Mar 4, 2020
1bc9c98
doc: dts: revisit documentation
mbolivar-nordic Mar 11, 2020
a9473a0
doc: west: add pointer to board porting guide for flash/debug
mbolivar-nordic Mar 17, 2020
19dc6af
doc: west: add FAQ for missing extension command
mbolivar-nordic Mar 31, 2020
2641bdb
doc: west: add FAQ for requires_workspace issue #373
mbolivar-nordic Mar 31, 2020
fc013c0
doc: west: link to modules page instead of source code
mbolivar-nordic Apr 7, 2020
d1ab9ed
doc: west: troubleshoot no west on PATH on windows
mbolivar-nordic Aug 18, 2020
2ebf885
doc: west: update west sign documentation
mbolivar-nordic Aug 31, 2020
afad4a4
doc: west: add information about private repositories
mbolivar-nordic Sep 17, 2020
b3073c4
doc: west: add missing 0.7.x docs
mbolivar-nordic Sep 9, 2020
51a1351
doc: west: API doc cleanups
mbolivar-nordic Sep 9, 2020
ab6cd3d
doc: west: changes for v0.8
mbolivar-nordic Sep 9, 2020
5bc2977
doc: west: fix typo in release notes
mbolivar-nordic Oct 6, 2020
6b45a45
doc: update west build --pristine
mbolivar-nordic Oct 7, 2020
b566fa9
doc: west: add inline comments in the tree and manifest examples
marc-hb Oct 8, 2020
d2d1898
doc: guides: debugging: Move to flash_debug dir
nandojve Nov 6, 2020
a74c23a
doc: improve west's repo-tool.rst
mbolivar-nordic Jan 6, 2021
b022a90
doc: west: add note about west update --keep-descendants option
marc-hb Jan 9, 2021
6f5f55a
doc: west: Fix config overrides
carlescufi Jan 26, 2021
b31d720
doc: west update can create loose commits
mbolivar-nordic Jan 11, 2021
01b2e8b
doc: west: add manifest.file config option
mbolivar-nordic Jan 13, 2021
159d6c0
doc: re-work west update to prep for new features
mbolivar-nordic Jan 12, 2021
ad37791
doc: west has moved to allowlist/blocklist
mbolivar-nordic Jan 7, 2021
1b615f4
doc: west: add project groups
mbolivar-nordic Jan 21, 2021
4e28c79
doc: west: add submodules
mbolivar-nordic Jan 12, 2021
ffa99ff
doc: west: update schema version
mbolivar-nordic Jan 12, 2021
68dde4e
doc: west: API changes for 0.9.0
mbolivar-nordic Jan 12, 2021
59dc6e6
doc: west: release notes for 0.9.0
mbolivar-nordic Jan 7, 2021
2cbd2c6
doc: west reserves refs/west/
mbolivar-nordic Jan 14, 2021
cc08a70
doc: clean up west index
mbolivar-nordic Feb 6, 2021
85b5817
doc: west: move advanced content out of 'basics'
mbolivar-nordic Feb 6, 2021
f7dabd7
doc: update west's workspaces.rst for 2.5
mbolivar-nordic Feb 6, 2021
48ade47
doc: add missing docs for 'west zephyr-export'
mbolivar-nordic Feb 6, 2021
8e23bc9
doc: improve manifest key docs
mbolivar-nordic Feb 7, 2021
c5ede4a
doc: improve docs on building without west
mbolivar-nordic Feb 7, 2021
5e192f3
doc: west: clean up example workspace
mbolivar-nordic Feb 8, 2021
415ced1
doc: west: improve troubleshooting for west update
mbolivar-nordic Feb 10, 2021
0988258
doc: west: make it clearer how to override the default runner
mbolivar-nordic Feb 22, 2021
e5059e5
doc: west: move 'manifest imports' to bottom of manifest.rst
mbolivar-nordic Feb 16, 2021
a1fdad5
doc: west: fix incorrect docs related to imports
mbolivar-nordic Feb 16, 2021
ba8295d
doc: west: clean up manifest import details
mbolivar-nordic Feb 16, 2021
51d3f4f
doc: west: document west 0.10 group-filter + import behavior
mbolivar-nordic Feb 17, 2021
1a91779
doc: west: projects list is optional in v0.10
mbolivar-nordic Mar 1, 2021
6d54913
doc: west: touch up remotes documentation
mbolivar-nordic Mar 1, 2021
f86b977
doc: west: submodule 'name' is optional after west 0.9.0
marc-hb Feb 9, 2021
c8de1de
doc: west: bump 'manifest: version:' docs
mbolivar-nordic Mar 1, 2021
cc00563
doc: west: 0.10.0 and 0.9.1 release notes
mbolivar-nordic Mar 1, 2021
410ba5d
doc: west: remove some unnecessary 'master' usages
mbolivar-nordic Mar 15, 2021
21b4cd9
doc: west: west init --mr changes for v0.10.1
mbolivar-nordic Mar 15, 2021
dc91d11
doc: west: fix submodule update info
mbolivar-nordic Apr 6, 2021
2174590
doc: west: add 0.11.0 docs
mbolivar-nordic May 4, 2021
e489bd6
doc: add docs for west spdx
mbolivar-nordic May 27, 2021
edb7390
doc: release-notes-2.6: west extensions
mbolivar-nordic May 27, 2021
ade14ac
doc: use kconfig role and directive
gmarull Jun 28, 2021
9a885ee
doc: west build: examples for -o and how to use -jN
mbolivar-nordic Jul 30, 2021
330e35a
doc: west v0.11.1 notes
mbolivar-nordic Aug 6, 2021
394be84
doc: west release 0.11.1 follow-ups
mbolivar-nordic Aug 10, 2021
3924f44
doc: west 0.12 docs
mbolivar-nordic Nov 4, 2021
702504e
doc: west: build-flash-debug: fix cmake arg example
bbilas Nov 16, 2021
6d94e8d
doc: drop single quote references
gmarull Dec 10, 2021
efee631
doc: use extlink for github issue links
henrikbrixandersen Jan 17, 2022
8978a25
doc: fix PDF build issue due to extlink references
gmarull Jan 17, 2022
6a24be4
doc: use :kconfig:option: domain role
gmarull Feb 7, 2022
03ede2a
everywhere: fix typos
nazar01 Mar 16, 2022
d263a37
doc: Fix west spdx command docs formatting bug
swinslow Mar 19, 2022
dd79708
doc: west: Add mention about Git rewrite feature
finikorg Mar 22, 2022
f9c4c31
doc: west: v0.13.0 docs
mbolivar-nordic Apr 4, 2022
c00cce9
doc: move west section to developing with zephyr
nashif Apr 5, 2022
701231d
doc: Fix spelling errors in .rst files
amarkovicsa Apr 13, 2022
acdadc1
doc: west 0.13.1 release notes
mbolivar-nordic Apr 20, 2022
0f73bde
doc: west: Add an example of using the credential store for GitHub
carlescufi Apr 26, 2022
b9bc618
doc: drop few reference of -s west build flag
fabiobaltieri Jul 9, 2022
729571e
doc: sysbuild documentation guide
tejlmand Mar 14, 2022
7ea94ee
blobs: Document the command and the module integration
carlescufi Aug 16, 2022
b9bbc25
doc: west: mention west blobs in without-west.rst
mbolivar-nordic Aug 19, 2022
2ed4b9d
doc: fix incorrect usage of envvar role
gmarull Aug 19, 2022
82faf29
doc: west v0.14 release notes
mbolivar-nordic Aug 29, 2022
6de5736
doc: west: Document the 'west completion' command
carlescufi Sep 6, 2022
cabd4e4
doc: manifest.rst: Describe using 'revision: HEAD~0' in manifests
oyvindronningstad Sep 9, 2022
045af4e
doc: west: Update outdated link to SPDX specification
stephanosio Sep 28, 2022
cea4626
tinycbor: Remove deprecated/obsolete module
nordicjm Jan 9, 2023
654fbab
west: Update documentation on twister script integration
asemjonovs Sep 26, 2022
0ecbf94
doc: west: improve 'manifest --validate' section
mbolivar-nordic Jan 20, 2023
547e565
doc: west: release notes for west v1.0
mbolivar-nordic Feb 17, 2023
661f0e3
.github: doc-build: move to west 1.0.0
mbolivar-nordic Feb 20, 2023
ec95f5e
doc: west: fix WestCommand self.configuration -> self.config
marc-hb Mar 12, 2023
aed9538
doc: add snippets documentation
mbolivar-nordic Jan 9, 2023
62a2e4f
doc: develop: west: sign: Add details on extending signing
nordicjm Mar 24, 2023
3585115
intel_adsp: move `west sign` from `west flash` to earlier `west build`
marc-hb Feb 24, 2023
50a06b5
docs/build-flash-debug: expand one-time CMake arguments section
marc-hb Apr 8, 2023
1f8798c
doc: modules: Clarify the difference between modules and projects
carlescufi Apr 5, 2023
1a40710
doc: west: apis: fix MalformedConfig autoclass
mbolivar-nordic May 19, 2023
0243139
doc: introduce EXTRA_CONF_FILE and EXTRA_DTC_OVERLAY_FILE
tejlmand May 17, 2023
b30d340
doc: west: clarify import example YAML
mbolivar-nordic May 23, 2023
980c58d
doc: west: improve "version:" documentation
mbolivar-nordic May 23, 2023
95a0b55
doc: west: troubleshooting: fix path
mbolivar-nordic May 31, 2023
b5b641e
doc: west: fix group filter documentation
mbolivar-nordic Jun 1, 2023
8ff6499
doc: west: v1.0.1 and v1.1.0 release notes
mbolivar-nordic Jun 2, 2023
8e858d9
west: doc: update link to SPDX doc
kartben Jun 6, 2023
101aa0e
documentation: Fix several typos
deining Aug 3, 2023
2288115
west: sign: do not make rimage configuration and platform name mandatory
iuliana-prodan Aug 22, 2023
efd332b
doc: west: Remove empty Footnotes rubric
finikorg Aug 15, 2023
5921393
doc: Migrate subsys/ code samples to new Sphinx extension
kartben Sep 6, 2023
89432bf
doc: bindesc: Add documentation for binary descriptors
yonsch Mar 25, 2023
ae759fc
doc: west: build: fix info on --pristine default
mbolivar-ampere Oct 11, 2023
2e61d44
doc: west: sort built-in project commands by name
mbolivar-ampere Oct 6, 2023
7770194
doc: west: add docs for west grep
mbolivar-ampere Oct 6, 2023
5451b69
doc: west: sort west.manifest.Project info by release
mbolivar-ampere Oct 6, 2023
7511ff7
doc: west: manifest file format changes for v1.2
mbolivar-ampere Oct 6, 2023
2156788
doc: west: API changes for v1.2
mbolivar-ampere Oct 6, 2023
a729804
doc: west: release notes for v1.2
mbolivar-ampere Oct 6, 2023
6e8ce39
doc: Fix double 'the'
butok Nov 15, 2023
151bab8
doc: Fix occurrences of repeated words
kartben Nov 15, 2023
a4e235e
scripts: zspdx: Include modules as packages in zephyr.spdx
tgagneret-embedded Dec 5, 2023
77d931a
doc: develop: fix typo
ndrs-pst Jan 25, 2024
b975092
doc: develop: west: sign: Add details on signing
nordicjm Jan 29, 2024
fcfea5e
Documentation: Update shell completion doc
Emplis Sep 18, 2023
7ad0804
west: spdx: introduce support for SPDX 2.3
kartben Mar 21, 2024
a859d4e
West: Add `west simulate` command
mszprejda Mar 7, 2024
d452380
West: Add `west robot` command
mszprejda Mar 7, 2024
b23514b
scripts: zephyr_module: Add URL, version to SPDX
tgagneret-embedded Jan 18, 2024
85d6ee4
doc: west: Clarify basic west terms
carlescufi Jun 25, 2024
d3b6064
doc: fix typo in multiple directories before v3.7.0 release
ndrs-pst Jul 6, 2024
15fa236
tools: net-tools: place net-tools inside tools
fg-cfh Sep 2, 2024
941fd40
doc: sphinx-lint: fix unbalanced-inline-literals-delimiters
kartben Sep 10, 2024
099c543
doc: sphinx-lint: fix bad usage of "default role"
kartben Sep 10, 2024
09308bc
samples: hello_world: use zephyr:code-sample directive
kartben Sep 11, 2024
ef814be
doc: build: Add signing page
nordicjm Sep 26, 2024
2656331
west: bindesc: Added get_offset command
yonsch Dec 20, 2023
60fc31d
doc: sign: minor rimage update following imgtool removal
marc-hb Oct 18, 2024
5c2e71d
boards: qemu: adopt new zephyr:board directive and role
kartben Oct 21, 2024
62564b5
doc: develop: west: Add alias documentation
pdgendt Jul 17, 2024
31c9891
doc: develop: west: Remove deprecated west.log
pdgendt Sep 29, 2024
ce011d2
doc: develop: Add external runners for modules information
pdgendt Dec 19, 2024
fb2ed19
doc: the west workspace topdir is not a git repository
mbolivar Jan 21, 2025
302d211
doc: document "west gtags" command
mbolivar Feb 19, 2025
863ba5c
scripts: west_commands: Add powershell autocompletion (west -b)
Apr 12, 2025
317df84
doc: sbom cmd more detail for build_dir
tobiwan88 Apr 16, 2025
5661507
doc: west: add documentation for west patch
cfriedt May 9, 2025
1127264
doc: develop: west: Update release notes
pdgendt May 15, 2025
4179bdb
doc: develop: west: Update west API for v1.4.0
pdgendt May 16, 2025
9ad84ca
doc: west: releases: Fix typo
carlescufi May 23, 2025
de59e0c
west: spdx: allow to generate for different SPDX versions
kartben May 28, 2025
0f90be4
doc: develop: west: document spdx not being supported for native_sim
kartben Jun 17, 2025
33464d6
scripts: west: spdx: extract copyright info
kartben Jun 11, 2025
da0470c
doc: sign: Describe usage of silabs_commander tool
jerome-pouiller Jun 25, 2025
5b3e4ff
docs: update https links
str4t0m Jul 28, 2025
e986cb5
doc: develop: west: alias: add example for auto-excluding platforms
henrikbrixandersen Aug 31, 2025
507dc83
west: blobs: fetch `--allow-regex` filter
noahp Aug 29, 2025
7234e67
doc: west: remove old west 0.6 and 0.7 related troubleshooting entries
kartben Sep 18, 2025
73fd760
doc: west: drop "Moving to West" doc page
kartben Sep 18, 2025
6253637
doc: develop: west: Add v1.5.0 release notes
pdgendt Sep 20, 2025
5f73e90
doc: develop: west: config: Add auto-cache
pdgendt Sep 23, 2025
7fefded
scripts: flash: Add west config for flash skip rebuild
Sep 16, 2025
8cdda9a
west: bindesc: add extract subcommand
pillo79 Oct 20, 2025
68d926f
doc: develop: west: config option build.dir-fmt
thorsten-klein Oct 24, 2025
7cd0230
doc: Move west to top-level doc/ directory
pdgendt Nov 6, 2025
ae97fe3
doc: Remove Zephyr specific files
pdgendt Nov 6, 2025
9992e7a
doc: Add sphinx conf.py and static resources
pdgendt Nov 6, 2025
f28b930
doc: West specific modifications
pdgendt Oct 2, 2025
91046db
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