From 0bf4963090b07e6e5a7807426ac4723f7bebf7a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vedran=20Mileti=C4=87?= Date: Wed, 1 Nov 2023 16:20:14 +0000 Subject: [PATCH] Quote pip arguments containing square brackets (#3456) This is strictly necessary when using non-bash shells (e.g. tcsh). --- docs/about/contributing.md | 2 +- docs/about/release-notes.md | 2 +- docs/dev-guide/themes.md | 2 +- docs/dev-guide/translations.md | 2 +- docs/user-guide/localizing-your-theme.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/about/contributing.md b/docs/about/contributing.md index 49f0fb23..6d03be0a 100644 --- a/docs/about/contributing.md +++ b/docs/about/contributing.md @@ -85,7 +85,7 @@ most likely need to have tests and documentation if it is a new feature. ### Submitting changes to the builtin themes -When installed with `i18n` support (`pip install mkdocs[i18n]`), MkDocs allows +When installed with `i18n` support (`pip install 'mkdocs[i18n]'`), MkDocs allows themes to support being translated into various languages (referred to as locales) if they respect [Jinja's i18n extension] by wrapping text placeholders with `{% trans %}` and `{% endtrans %}` tags. diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md index d00f5be1..3eab10e7 100644 --- a/docs/about/release-notes.md +++ b/docs/about/release-notes.md @@ -733,7 +733,7 @@ happen by default. Users must first install the necessary dependencies with the following command: ```bash -pip install mkdocs[i18n] +pip install 'mkdocs[i18n]' ``` Translation contributions are welcome and detailed in the [Translation diff --git a/docs/dev-guide/themes.md b/docs/dev-guide/themes.md index 0bba0edd..51290b66 100644 --- a/docs/dev-guide/themes.md +++ b/docs/dev-guide/themes.md @@ -1038,7 +1038,7 @@ WARNING: As **[pybabel] is not installed by default** and most users will not have pybabel installed, theme developers and/or translators should make sure to have installed the necessary dependencies -(using `pip install mkdocs[i18n]`) in order for the commands to be +(using `pip install 'mkdocs[i18n]'`) in order for the commands to be available for use. The translation commands should be called from the root of your theme's working tree. diff --git a/docs/dev-guide/translations.md b/docs/dev-guide/translations.md index 13d0226e..b01f5703 100644 --- a/docs/dev-guide/translations.md +++ b/docs/dev-guide/translations.md @@ -38,7 +38,7 @@ are working from a properly configured development environment. Make sure translation requirements are installed in your environment: ```bash -pip install mkdocs[i18n] +pip install 'mkdocs[i18n]' ``` [babel]: https://babel.pocoo.org/en/latest/cmdline.html diff --git a/docs/user-guide/localizing-your-theme.md b/docs/user-guide/localizing-your-theme.md index 42c81fc9..279f4a8e 100644 --- a/docs/user-guide/localizing-your-theme.md +++ b/docs/user-guide/localizing-your-theme.md @@ -17,7 +17,7 @@ For theme localization to work, you must use a theme which supports it and enable `i18n` (internationalization) support by installing `mkdocs[i18n]`: ```bash -pip install mkdocs[i18n] +pip install 'mkdocs[i18n]' ``` ## Supported locales