From c50de2db4d64e9457c8d87ee40285c0d0e777446 Mon Sep 17 00:00:00 2001 From: Pamphile Roy Date: Tue, 25 Jan 2022 12:21:36 +0100 Subject: [PATCH] DOC: add extra_classes in one example --- docs/user_guide/configuring.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/user_guide/configuring.rst b/docs/user_guide/configuring.rst index c536bffe4..bab8c2c98 100644 --- a/docs/user_guide/configuring.rst +++ b/docs/user_guide/configuring.rst @@ -386,9 +386,9 @@ each have one or two fields: switcher. - ``name``: an optional name to display in the switcher dropdown instead of the version string (e.g., "latest", "stable", "dev", etc). -- ``extra_classes``: an optional list of classes to add to a version - (e.g., ``["dev", "hide"]``). These classes are only added when the version - is active. +- ``extra_classes``: an optional list of classes to add to the switcher + button for a given version (e.g., ``["dev", "rc"]``). These classes are only + added when the version is active. Here is an example JSON file: @@ -399,6 +399,10 @@ Here is an example JSON file: "name": "v2.1 (stable)", "version": "2.1" }, + { + "version": "2.1rc1", + "extra_classes": ["dev", "rc"] + }, { "version": "2.0" },