Skip to content

docs: clarify wlc changed behavior #17591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nijel merged 1 commit into from
Jan 13, 2026
Merged

docs: clarify wlc changed behavior #17591

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion docs/wlc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,33 @@ You can then invoke commands on the default server:

:ref:`wlc-config`

.. _wlc_legacy:

Legacy configuration
++++++++++++++++++++

.. versionchanged:: 1.17

The legacy configuration using unscoped ``key`` is no longer supported.

Migrate legacy configuration:

.. code-block:: ini

[weblate]
url = https://hosted.weblate.org/api
key = YOUR_KEY_HERE

To a configuration with key scoped to an API URL:

.. code-block:: ini

[weblate]
url = https://hosted.weblate.org/api

[keys]
https://hosted.weblate.org/api = YOUR_KEY_HERE

Synopsis
++++++++

Expand Down Expand Up @@ -287,7 +314,7 @@ customize this by :option:`--config-section`):

.. versionremoved:: 1.17

Use the ``[keys]`` section to specify keys scoped for individual API URLs.
Use the ``[keys]`` section to specify keys scoped for individual API URLs, see :ref:`wlc_legacy`.

.. describe:: url

Expand Down
Loading