Skip to content

Commit 1a34e95

Browse files
kumekaykumekay
committed
Merge branch 'docs/describe_env_variables' into 'main'
docs: add environment variables description Closes PACMAN-500 See merge request espressif/idf-component-manager!519
2 parents 8ef04a0 + f84a9fb commit 1a34e95

21 files changed

+1003
-956
lines changed

‎.git-blame-ignore-revs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,5 @@ a5e85486930ea416406ed1b3b24e7b22aeaeb2cc
1010
90f071b1e6842a5c27feeedbeec8728bfc99f1a3
1111
# ruff "remove unused noqa"
1212
430927cb495aa44462473697f4561bf2d5d28d1e
13+
# Reformat all rst files using docstrfmt
14+
a002d37f54c3e3d9132916590f2b65b96079b78c

‎.pre-commit-config.yaml‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -62,16 +62,12 @@ repos:
6262
- --types=change,chore,ci,docs,feat,fix,refactor,remove,revert,test
6363
- --allow-breaking
6464

65-
- repo: https://github.com/hfudev/rstfmt
66-
rev: v0.1.4
65+
- repo: https://github.com/LilSpazJoekp/docstrfmt
66+
rev: v1.10.0
6767
hooks:
68-
- id: rstfmt
69-
args: ["-w", "-1"]
70-
files: "docs\/.+rst$"
71-
additional_dependencies: [
72-
"sphinx_tabs",
73-
"sphinx-click",
74-
]
68+
- id: docstrfmt
69+
types: [rst]
70+
args: ['-l', '99999999999999999999999'] # Set a very high line length limit to avoid wrapping lines in docstrings.
7571

7672
- repo: https://github.com/executablebooks/mdformat
7773
rev: 0.7.18

‎README.md‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -151,19 +151,3 @@ examples:
151151
- path: ../some/other_path
152152
# - path: examples/some_example # this example will be discovered automatically
153153
```
154-
155-
## Environment variables
156-
157-
| Variable | Default value (or example for required) | Description |
158-
| -------------------------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
159-
| IDF_COMPONENT_API_TOKEN | | API token to access the component registry |
160-
| IDF_COMPONENT_REGISTRY_URL | https://components.espressif.com/ | URL of the default component registry |
161-
| IDF_COMPONENT_STORAGE_URL | https://components-file.espressif.com/ | URL of the default file storage server |
162-
| IDF_COMPONENT_PROFILE | default | Profile in the config file to use |
163-
| IDF_COMPONENT_CACHE_PATH | \* Depends on OS | Cache directory for Component Manager |
164-
| IDF_COMPONENT_VERSION_PROCESS_TIMEOUT | 300 | Timeout in seconds to wait for component processing |
165-
| IDF_COMPONENT_OVERWRITE_MANAGED_COMPONENTS | 0 | Overwrite files in the managed_component directory, even if they have been modified by the user |
166-
| IDF_COMPONENT_SUPPRESS_UNKNOWN_FILE_WARNINGS | 0 | Ignore unknown files in managed_components directory |
167-
| IDF_COMPONENT_CHECK_NEW_VERSION | 1 | Check for new versions of components |
168-
| IDF_COMPONENT_VERIFY_SSL | 1 | Verify SSL certificates when making requests to the registry, set it 0 to disable or provide a CA bundle path |
169-
| IDF_COMPONENT_CACHE_HTTP_REQUESTS | 1 | Cache HTTP requests to the registry during runtime, set it 0 to disable |

‎docs/_static/theme_overrides.css‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,9 @@
4949
font-weight: bold;
5050
font-style: italic;
5151
}
52+
53+
/* Wrap too long sidebar menu items */
54+
ul li code {
55+
word-wrap: break-word;
56+
white-space: unset;
57+
}

‎docs/conf_common.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
'sphinx_copybutton',
2828
'sphinx_tabs.tabs',
2929
'sphinx_click',
30+
'sphinxcontrib.autodoc_pydantic',
3031
]
3132
smartquotes = False
3233
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

‎docs/en/getting_started/index.rst‎

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,43 @@
1-
#################
2-
Getting Started
3-
#################
1+
Getting Started
2+
===============
43

54
The IDF Component Manager comes pre-installed and enabled by default in all `supported ESP-IDF versions <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/versions.html>`_.
65

7-
********************************************
8-
Checking the IDF Component Manager Version
9-
********************************************
6+
Checking the IDF Component Manager Version
7+
------------------------------------------
108

119
If you're unsure which version of the IDF Component Manager is included in your ESP-IDF installation, you can check it using a CLI command.
1210

1311
First, activate the `ESP-IDF environment <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#installation>`_, then run the help command:
1412

1513
.. tabs::
1614

17-
.. group-tab::
15+
.. group-tab::
1816

19-
Windows
17+
Windows
2018

21-
Open ``ESP-IDF PowerShell Environment`` or ``ESP-IDF Command Prompt (cmd.exe)`` from the Start menu and run the following command:
19+
Open ``ESP-IDF PowerShell Environment`` or ``ESP-IDF Command Prompt (cmd.exe)`` from the Start menu and run the following command:
2220

23-
.. code:: powershell
21+
.. code:: powershell
2422
25-
> compote version
23+
> compote version
2624
27-
.. group-tab::
25+
.. group-tab::
2826

29-
macOS and Linux (bash or zsh)
27+
macOS and Linux (bash or zsh)
3028

31-
.. code:: bash
29+
.. code:: bash
3230
33-
$ source $IDF_PATH/export.sh
34-
$ compote version
31+
$ source $IDF_PATH/export.sh
32+
$ compote version
3533
36-
.. group-tab::
34+
.. group-tab::
3735

38-
macOS and Linux (fish)
36+
macOS and Linux (fish)
3937

40-
.. code:: fishshell
38+
.. code:: fishshell
4139
42-
$ . $IDF_PATH/export.fish
43-
$ compote version
40+
$ . $IDF_PATH/export.fish
41+
$ compote version
4442
45-
If you're using an older version of the Component Manager, the ``compote version`` command might not be available. In that case, consider upgrading to the latest version. For details, see `Upgrading the IDF Component Manager <#installing-and-upgrading-the-idf-component-manager>`_.
43+
If you're using an older version of the Component Manager, the ``compote version`` command might not be available. In that case, consider upgrading to the latest version. For details, see :doc:`Upgrading the IDF Component Manager <../guides/updating_component_manager>`.

‎docs/en/guides/configuration.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Configuration of the IDF Component Manager
2+
==========================================
3+
4+
IDF Component Manager can be configured using two methods:
5+
6+
1. **Configuration File**: A YAML file named ``idf_component_manager.yml`` that defines profiles for component management. More details about this file can be found in the :doc:`Configuration File <../reference/config_file>`.
7+
2. **Environment Variables**: A set of environment variables that can override the settings in the configuration file. These variables are documented below.
8+
9+
.. note::
10+
11+
Environment variables have higher precedence than the configuration file. If a setting is defined in both the configuration file and an environment variable, the value from the environment variable will be used.
12+
13+
.. autopydantic_settings:: idf_component_tools.environment.ComponentManagerEnvVariables
14+
:settings-show-json: false
15+
:settings-signature-prefix: class
16+
:settings-show-field-summary: false
17+
:field-doc-policy: description
18+
:field-signature-prefix: attribute

0 commit comments

Comments
 (0)