Skip to content

Commit

Permalink
Merge branch 'fix/docs_tools' into 'master'
Browse files Browse the repository at this point in the history
fix(tools): Remove idf.py dependencies from documentation

See merge request espressif/esp-idf!27101
  • Loading branch information
dobairoland committed Nov 14, 2023
2 parents 159beab + 6f50b02 commit dd1247f
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 4 deletions.
2 changes: 0 additions & 2 deletions docs/en/api-guides/tools/idf-py.rst
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,6 @@ For commands that are not known to ``idf.py``, an attempt to execute them as a b

The command ``idf.py`` supports `shell autocompletion <https://click.palletsprojects.com/shell-completion/>`_ for bash, zsh and fish shells.

In order to make `shell autocompletion <https://click.palletsprojects.com/shell-completion/>`_ supported, please make sure you have at least Python 3.5 and `click <https://click.palletsprojects.com/>`_ 7.1 or newer (:ref:`Software <get-started-get-prerequisites>`).

To enable autocompletion for ``idf.py``, use the ``export`` command (:ref:`Step 4. Set up the environment variables <get-started-set-up-env>`). Autocompletion is initiated by pressing the TAB key. Type ``idf.py -`` and press the TAB key to autocomplete options.

The autocomplete support for PowerShell is planned in the future.
Expand Down
2 changes: 0 additions & 2 deletions docs/zh_CN/api-guides/tools/idf-py.rst
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,6 @@ ESP-IDF 支持多个目标芯片,运行 ``idf.py --list-targets`` 查看当前

命令 ``idf.py`` 支持 bash、zsh 和 fish shell 的 `shell 自动补全 <https://click.palletsprojects.com/shell-completion/>`_。

为实现 `shell 自动补全 <https://click.palletsprojects.com/shell-completion/>`_,请确保 Python 版本为 3.5 及以上,`click <https://click.palletsprojects.com/>`_ 版本为 7.1 及以上(请参阅 :ref:`软件 <get-started-get-prerequisites>`)。

调用命令 ``export`` 为 ``idf.py`` 启用自动补全(:ref:`第四步:设置环境变量 <get-started-set-up-env>`),按 TAB 键启动自动补全。输入 ``idf.py -`` 并按 TAB 键以自动补全选项。

预计未来版本将支持 PowerShell 自动补全。
Expand Down

0 comments on commit dd1247f

Please sign in to comment.