From b3f8b314580133474ae6c3e358f52f79c60da742 Mon Sep 17 00:00:00 2001 From: Marco Bonetti Date: Sun, 23 Jun 2024 15:28:39 +0200 Subject: [PATCH] docs: note on requirement for openapi translation --- docs/settings.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/settings.rst b/docs/settings.rst index 97db263..b6cf9f2 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -28,7 +28,7 @@ Rosetta can be configured via the following parameters, to be defined in your pr * ``ROSETTA_LANGUAGES``: List of languages that Rosetta will offer to translate. This is useful when you wish to translate a language that is not yet defined in ``settings.LANGUAGES``. Defaults to ``settings.LANGUAGES``. * ``ROSETTA_SHOW_OCCURRENCES``: Determines whether occurrences (where the original text appears) should be shown next to the translations for context. Defaults to ``True``. * ``ROSETTA_CASE_SENSITIVE_FILESYSTEM``: Overrides auto-detection of case sensitive OS. Defaults to ``None`` which enables auto-detection. Useful when running case sensitive OS (e.g. Ubuntu) in docker on case insensitive OS (e.g. MacOS). -* ``OPENAI_API_KEY``: Translation suggestions using the OpenAI API. To use this service, you must first `register for the service `, and set ``OPENAI_API_KEY`` to the key listed for your subscription. Defaults to ``None``. +* ``OPENAI_API_KEY``: Translation suggestions using the OpenAI API. To use this service, you must first `register for the service `, and set ``OPENAI_API_KEY`` to the key listed for your subscription. Requires `openai-python`. Defaults to ``None``.