Skip to content

Commit

Permalink
Merge branch 'docs/examples_paths' into 'main'
Browse files Browse the repository at this point in the history
docs: Fix examples paths syntax in the docs

See merge request espressif/idf-component-manager!436
  • Loading branch information
kumekay committed Aug 20, 2024
2 parents da77faf + ab6ef68 commit d927cbd
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/en/reference/manifest_file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,16 +196,16 @@ A list of files and directories excluded by default:

A list of directories with examples.

This field is optional and can be omitted if all the component examples are located in the ``examples`` directory.
This field is optional, if you don't have any examples outside of the ``examples`` directory. The ESP Component Registry will automatically discover examples in the ``examples`` directory and its subdirectories.

Example:

.. code:: yaml
examples:
- custom_example_path_1
- custom_example_path_2
# - examples/foo # no need to be listed if the example is under "examples" folder
- path: custom_example_path_1
- path: custom_example_path_2
# - path: examples/foo # no need to be listed if the example is under "examples" folder
``url``
=======
Expand Down

0 comments on commit d927cbd

Please sign in to comment.