Skip to content

Commit

Permalink
Add channel_settings to documentation (#13730)
Browse files Browse the repository at this point in the history
  • Loading branch information
travishathaway committed Mar 26, 2024
1 parent b7c4b94 commit 11c21d5
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
2 changes: 1 addition & 1 deletion conda/base/context.py
Original file line number Diff line number Diff line change
Expand Up @@ -1171,6 +1171,7 @@ def category_map(self):
"Channel Configuration": (
"channels",
"channel_alias",
"channel_settings",
"default_channels",
"override_channels_enabled",
"allowlist_channels",
Expand Down Expand Up @@ -1272,7 +1273,6 @@ def category_map(self):
"allow_cycles", # allow cyclical dependencies, or raise
"allow_conda_downgrades",
"add_pip_as_python_dependency",
"channel_settings",
"debug",
"trace",
"dev",
Expand Down
29 changes: 29 additions & 0 deletions docs/source/user-guide/configuration/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,35 @@ repository, an administrator can set both :ref:`channel alias <channel-alias>` a
.. _auto-update-conda:


.. _channel-settings:

``channel_settings``: Extra settings for individual channels
------------------------------------------------------------

.. versionadded:: 23.3.0

With ``channel_settings``, it is possible to add extra configuration options
for individual channels. This is currently used to register additional authentication
handlers for conda via the :doc:`/dev-guide/plugins/auth_handlers` plugin hook, but may also
accommodate more use cases in the future.

Here is an example of how it may be defined provided there was an available authentication
handler called, "test-auth-handler" registered via the aforementioned plugin hook:

.. code-block:: yaml
channel_settings:
- channel: https://some.custom/channel
auth: test-auth-handler
user: my-user-account
.. note::

Each entry in ``channel_settings`` needs to define the ``channel`` attribute so that
the configuration knows which channel these settings are associated with.


``auto_update_conda``: Update conda automatically
-------------------------------------------------

Expand Down

0 comments on commit 11c21d5

Please sign in to comment.