Lines Matching refs:west
4 .. _west-apis-west:
9 This page documents the Python APIs provided by :ref:`west <west>`, as well as
10 some additional APIs used by the :ref:`west extensions <west-extensions>` in
21 2. if you add a :ref: target here, add it to west-not-found.rst too.
25 west.commands
28 .. module:: west.commands
37 .. autoclass:: west.commands.WestCommand
71 A property which returns the :py:class:`west.manifest.Manifest`
87 :py:class:`west.configuration.Configuration` instance or aborts the
108 True if the west configuration permits colorized output,
141 expediency during the west v1.2 release time frame to work around a build
143 cutting a west point release. (The docstrings in west had some RST syntax
182 ``west.log`` module to a per-command interface that will allow for a global
183 "quiet" mode for west commands in a future release:
219 Since west v1.0, west commands should print output using methods like
220 west.commands.WestCommand.dbg(), west.commands.WestCommand.inf(), etc. (see
223 .. autoclass:: west.commands.Verbosity
238 .. autoclass:: west.commands.CommandError
245 .. autoclass:: west.commands.CommandContextError
250 west.configuration
253 .. automodule:: west.configuration
255 Since west v0.13, the recommended class for reading this is
256 :py:class:`west.configuration.Configuration`.
258 Note that if you are writing a :ref:`west extension <west-extensions>`, you can
260 :py:class:`west.commands.WestCommand`.
265 This is the recommended API to use since west v0.13.
267 .. autoclass:: west.configuration.ConfigFile
269 .. autoclass:: west.configuration.Configuration
277 The following APIs also use :py:class:`west.configuration.ConfigFile`, but they
279 configuration. This has proven to be a bad design decision since west's APIs
280 can be used from multiple workspaces. They were deprecated in west v0.13.0.
283 not be used in new code when west v0.13.0 or later may be assumed.
285 .. autofunction:: west.configuration.read_config
293 .. autofunction:: west.configuration.update_config
295 .. py:data:: west.configuration.config
298 should be initialized with :py:func:`west.configuration.read_config` before
303 west.log (deprecated)
306 .. automodule:: west.log
340 west.manifest
343 .. automodule:: west.manifest
346 represent the contents of a :ref:`manifest file <west-manifests>`. The
347 recommended method for parsing west manifests is
359 .. autofunction:: west.manifest.manifest_path
361 .. autofunction:: west.manifest.validate
369 .. autoclass:: west.manifest.Manifest
422 option. See :ref:`west-config-index`.
424 .. autoclass:: west.manifest.ImportFlag
428 .. autoclass:: west.manifest.Project
505 .. autoclass:: west.manifest.ManifestProject
519 .. autoclass:: west.manifest.Submodule
526 .. autoclass:: west.configuration.MalformedConfig
529 .. autoclass:: west.manifest.MalformedManifest
532 .. autoclass:: west.manifest.ManifestVersionError
538 .. autoclass:: west.manifest.ManifestImportFailed
549 west.util
554 .. automodule:: west.util
559 .. autofunction:: west.util.west_dir
564 .. autofunction:: west.util.west_topdir
572 .. autoclass:: west.util.WestNotFound