Update docusaurus to v3 (#3077)

Author: jesszzzz

website/blog/2020-09-03-Hydra_1.0.md

@@ -26,19 +26,19 @@ OPTION                 : CONFIG_NAME|CONFIG_NAMES|null
 
 *GROUP_DEFAULT* : An *overridable* config. e.g. `db: mysql`, `db@backup: mysql`.
 - ***override*** : Overrides the option of a previously defined GROUP_DEFAULT.
-- ***optional*** : By default, an OPTION that do not exist causes an error; optional suppresses the error. 
+- ***optional*** : By default, an OPTION that do not exist causes an error; optional suppresses the error.
 - ***null*** : A place-holder for a future override. If it is not overridden the entry is ignored.
 
 *CONFIG_NAME*: The name of a config, without the file system extension. e.g. `mysql` and not `mysql.yaml`.
 
 *CONFIG_NAMES* : A list of config names. e.g. `[mysql, sqlite]`
 
-*CONFIG_GROUP* : A path to a set of configs.   
-The path is relative to the containing config. 
-It can be made absolute by prefixing it with a `/`.  
+*CONFIG_GROUP* : A path to a set of configs.
+The path is relative to the containing config.
+It can be made absolute by prefixing it with a `/`.
 The path separator is `/` regardless of the operating system.
 
-*OPTION*: The currently selected *CONFIG_NAME* or *CONFIG_NAMES* from a *CONFIG_GROUP*. 
+*OPTION*: The currently selected *CONFIG_NAME* or *CONFIG_NAMES* from a *CONFIG_GROUP*.
 
 *PACKAGE* : Where to place the content of the config within the output config.
 It is relative to the Package of the containing config by default. See [Packages](overriding_packages.md).
@@ -130,7 +130,7 @@ debug: false
 </div>
 </div>
 
-A Config Group's option can also be overridden via the command line. e.g:  
+A Config Group's option can also be overridden via the command line. e.g:
 ```
 $ python my_app.py server/db=sqlite
 ```
@@ -147,7 +147,7 @@ By default, the content of a config is overriding the content of configs in the
 
 ```yaml title="config.yaml" {5}
 defaults:
-  - db: mysql  
+  - db: mysql
 
 db:
   host: backup
@@ -168,7 +168,7 @@ db:
 </div>
 </div>
 
-The `_self_` entry determines the relative position of **this** config in the Defaults List. 
+The `_self_` entry determines the relative position of **this** config in the Defaults List.
 If it is not specified, it is added automatically as the last item.
 
 <div className="row">
@@ -177,7 +177,7 @@ If it is not specified, it is added automatically as the last item.
 ```yaml title="config.yaml" {2,6}
 defaults:
   - _self_
-  - db: mysql # Overrides this config 
+  - db: mysql # Overrides this config
 
 db:
   host: backup
@@ -196,7 +196,7 @@ db:
 </div>
 </div>
 
-With `_self_` at the top of the Defaults List, the host field defined in *config.yaml* now precedes the host field defined 
+With `_self_` at the top of the Defaults List, the host field defined in *config.yaml* now precedes the host field defined
 in *db/mysql.yaml*, and as a result is overridden.
 
 ## Interpolation in the Defaults List
@@ -208,10 +208,10 @@ defaults:
   - db: mysql
   - combination_specific_config: ${server}_${db}  # apache_mysql
 ```
-Interpolation keys can be config groups with any @package overrides.  
+Interpolation keys can be config groups with any @package overrides.
 For example: `${db/engine}`, `${db@backup}`
 
-The selected option for *combination_specific_config* depends on the final selected options for *db* and *server*.  
+The selected option for *combination_specific_config* depends on the final selected options for *db* and *server*.
 e.g., If *db* is overridden to *sqlite*, *combination_specific_config* will become *apache_sqlite*.
 
 #### Restrictions:
@@ -236,61 +236,63 @@ You can inspect these artifacts via command line flags:
 - `--cfg job|hydra|all` Shows the Output Config.
 
 Example outputs:
-<details><summary>python my_app.py <b>--info defaults-tree</b></summary>
-
-```yaml title=""
-<root>:
-  hydra/config:
-    hydra/hydra_logging: default
-    hydra/job_logging: default
-    hydra/launcher: basic
-    hydra/sweeper: basic
-    hydra/output: default
-    hydra/help: default
-    hydra/hydra_help: default
-    _self_
-  config:
-    server/apache:
-      server/db: mysql
+
+<details>
+  <summary>python my_app.py <b>--info defaults-tree</b></summary>
+  ```yaml title=""
+  <root>:
+    hydra/config:
+      hydra/hydra_logging: default
+      hydra/job_logging: default
+      hydra/launcher: basic
+      hydra/sweeper: basic
+      hydra/output: default
+      hydra/help: default
+      hydra/hydra_help: default
       _self_
-    _self_
-```
+    config:
+      server/apache:
+        server/db: mysql
+        _self_
+      _self_
+  ```
 </details>
-<details><summary>python my_app.py <b>--info defaults</b></summary>
-
-```text
-Defaults List
-*************
-| Config path                 | Package             | _self_ | Parent        | 
--------------------------------------------------------------------------------
-| hydra/hydra_logging/default | hydra.hydra_logging | False  | hydra/config  |
-| hydra/job_logging/default   | hydra.job_logging   | False  | hydra/config  |
-| hydra/launcher/basic        | hydra.launcher      | False  | hydra/config  |
-| hydra/sweeper/basic         | hydra.sweeper       | False  | hydra/config  |
-| hydra/output/default        | hydra               | False  | hydra/config  |
-| hydra/help/default          | hydra.help          | False  | hydra/config  |
-| hydra/hydra_help/default    | hydra.hydra_help    | False  | hydra/config  |
-| hydra/config                | hydra               | True   | <root>        |
-| server/db/mysql             | server.db           | False  | server/apache |
-| server/apache               | server              | True   | config        |
-| config                      |                     | True   | <root>        |
--------------------------------------------------------------------------------
-```
+<details>
+  <summary>python my_app.py <b>--info defaults</b></summary>
+
+  ```text
+  Defaults List
+  *************
+  | Config path                 | Package             | _self_ | Parent        |
+  -------------------------------------------------------------------------------
+  | hydra/hydra_logging/default | hydra.hydra_logging | False  | hydra/config  |
+  | hydra/job_logging/default   | hydra.job_logging   | False  | hydra/config  |
+  | hydra/launcher/basic        | hydra.launcher      | False  | hydra/config  |
+  | hydra/sweeper/basic         | hydra.sweeper       | False  | hydra/config  |
+  | hydra/output/default        | hydra               | False  | hydra/config  |
+  | hydra/help/default          | hydra.help          | False  | hydra/config  |
+  | hydra/hydra_help/default    | hydra.hydra_help    | False  | hydra/config  |
+  | hydra/config                | hydra               | True   | <root>        |
+  | server/db/mysql             | server.db           | False  | server/apache |
+  | server/apache               | server              | True   | config        |
+  | config                      |                     | True   | <root>        |
+  -------------------------------------------------------------------------------
+  ```
 </details>
-<details><summary>python my_app.py <b>--cfg job</b></summary>
-
-```yaml
-server:
-  db:
-    name: mysql
-  name: apache
-debug: false
-```
+<details>
+  <summary>python my_app.py <b>--cfg job</b></summary>
+
+  ```yaml
+  server:
+    db:
+      name: mysql
+    name: apache
+  debug: false
+  ```
 </details>
 
 ## Related topics
 - [Packages](overriding_packages.md)
 - [Common Patterns/Extending Configs](patterns/extending_configs.md)
 - [Common Patterns/Configuring Experiments](patterns/configuring_experiments.md)
 - [Selecting multiple configs from a Config Group](patterns/select_multiple_configs_from_config_group.md)
-

website/docs/advanced/defaults_list.md

@@ -28,45 +28,46 @@ HYDRA_INSTANTIATE_ALLOWLIST_OVERRIDE with a colon-separated list of modules to a
 eg. `HYDRA_INSTANTIATE_ALLOWLIST_OVERRIDE=os.rename:shutil.move`
 :::
 
-<details><summary>Instantiate API (Expand for details)</summary>
-
-```python
-def instantiate(config: Any, *args: Any, **kwargs: Any) -> Any:
-    """
-    :param config: An config object describing what to call and what params to use.
-                   In addition to the parameters, the config must contain:
-                   _target_ : target class or callable name (str)
-                   And may contain:
-                   _args_: List-like of positional arguments to pass to the target
-                   _recursive_: Construct nested objects as well (bool).
-                                True by default.
-                                may be overridden via a _recursive_ key in
-                                the kwargs
-                   _convert_: Conversion strategy
-                        none    : Passed objects are DictConfig and ListConfig, default
-                        partial : Passed objects are converted to dict and list, with
-                                  the exception of Structured Configs (and their fields).
-                        object  : Passed objects are converted to dict and list.
-                                  Structured Configs are converted to instances of the
-                                  backing dataclass / attr class.
-                        all     : Passed objects are dicts, lists and primitives without
-                                  a trace of OmegaConf containers. Structured configs
-                                  are converted to dicts / lists too.
-                   _partial_: If True, return functools.partial wrapped method or object
-                              False by default. Configure per target.
-    :param args: Optional positional parameters pass-through
-    :param kwargs: Optional named parameters to override
-                   parameters in the config object. Parameters not present
-                   in the config objects are being passed as is to the target.
-                   IMPORTANT: dataclasses instances in kwargs are interpreted as config
-                              and cannot be used as passthrough
-    :return: if _target_ is a class name: the instantiated object
-             if _target_ is a callable: the return value of the call
-    """
-
-# Alias for instantiate
-call = instantiate
-```
+<details>
+    <summary>Instantiate API (Expand for details)</summary>
+
+    ```python
+    def instantiate(config: Any, *args: Any, **kwargs: Any) -> Any:
+        """
+        :param config: An config object describing what to call and what params to use.
+                       In addition to the parameters, the config must contain:
+                       _target_ : target class or callable name (str)
+                       And may contain:
+                       _args_: List-like of positional arguments to pass to the target
+                       _recursive_: Construct nested objects as well (bool).
+                                    True by default.
+                                    may be overridden via a _recursive_ key in
+                                    the kwargs
+                       _convert_: Conversion strategy
+                            none    : Passed objects are DictConfig and ListConfig, default
+                            partial : Passed objects are converted to dict and list, with
+                                      the exception of Structured Configs (and their fields).
+                            object  : Passed objects are converted to dict and list.
+                                      Structured Configs are converted to instances of the
+                                      backing dataclass / attr class.
+                            all     : Passed objects are dicts, lists and primitives without
+                                      a trace of OmegaConf containers. Structured configs
+                                      are converted to dicts / lists too.
+                       _partial_: If True, return functools.partial wrapped method or object
+                                  False by default. Configure per target.
+        :param args: Optional positional parameters pass-through
+        :param kwargs: Optional named parameters to override
+                       parameters in the config object. Parameters not present
+                       in the config objects are being passed as is to the target.
+                       IMPORTANT: dataclasses instances in kwargs are interpreted as config
+                                  and cannot be used as passthrough
+        :return: if _target_ is a class name: the instantiated object
+                 if _target_ is a callable: the return value of the call
+        """
+
+    # Alias for instantiate
+    call = instantiate
+    ```
 
 </details><br/>
 

website/docs/advanced/instantiate_objects/overview.md

@@ -212,7 +212,7 @@ $ python my_app.py 'dir=A\[B'   # ok
 - `float`: 3.14, -10e6, inf, -inf, nan.
 - `bool`: true, false
 - `dot_path`: foo.bar
-- `interpolation`: ${foo.bar}, ${oc.env:USER,me}
+- `interpolation`: $\{foo.bar}, $\{oc.env:USER,me}
 
 Constants (null, true, false, inf, nan) are case-insensitive.
 

website/docs/advanced/override_grammar/basic.md

@@ -404,17 +404,17 @@ Input are grouped by type.
 |       “true”       	| error       	| error             	| “true”            	| true                  	| '“true”'               |
 |       “false”      	| error       	| error             	| “false”           	| false                 	| '“false”'              |
 |      “[1,2,3]”     	| error       	| error             	| “[1,2,3]”         	| error                 	| '“[1,2,3]”'            |
-|      “{a:10}”      	| error       	| error             	| “{a:10}”          	| error                 	| '“{a:10}”'             |
+|      “\{a:10}”      	| error       	| error             	| “\{a:10}”          	| error                 	| '“\{a:10}”'             |
 |        true        	| 1           	| 1.0               	| “true”            	| true                  	| “true”                 |
 |        false       	| 0           	| 0.0               	| “false”           	| false                 	| “false”                |
 |         []         	| []          	| []                	| []                	| []                    	| “[]”                   |
 |       [0,1,2]      	| [0,1,2]     	| [0.0,1.0,2.0]     	| [“0”,”1”,”2”]     	| [false,true,true]     	| “[1, 2, 3]”            |
 |       [1,[2]]      	| [1,[2]]     	| [1.0,[2.0]]       	| [“1”,[“2”]]       	| [true,[true]]         	| “[1, [2]]”             |
 |        [a,1]       	| error       	| error             	| [“a”,”1”]         	| error                 	| '[“a”, 1]'             |
-|         {}         	| {}          	| {}                	| {}                	| {}                    	| “{}”                   |
-|       {a:10}       	| {a:10}      	| {a:10.0}          	| {a:”10”}          	| {a: true}               	| '{“a”: 10}'            |
-|     {a:[0,1,2]}    	| {a:[0,1,2]} 	| {a:[0.0,1.0,2.-]} 	| {a:[“0”,”1”,”2”]} 	| {a:[false,true,true]} 	| '{“a”: [1, 2, 3]}'     |
-|    {a:10,b:xyz}    	| error       	| error             	| {a:”10”,b:”xyz”}  	| error                 	| '{“a”: 10, “b”: “xyz”}'|
+|         \{}         	| \{}          	| \{}                	| \{}                	| \{}                    	| “\{}”                   |
+|       \{a:10}       	| \{a:10}      	| \{a:10.0}          	| \{a:”10”}          	| \{a: true}               	| '\{“a”: 10}'            |
+|     \{a:[0,1,2]}    	| \{a:[0,1,2]} 	| \{a:[0.0,1.0,2.-]} 	| \{a:[“0”,”1”,”2”]} 	| \{a:[false,true,true]} 	| '\{“a”: [1, 2, 3]}'     |
+|    \{a:10,b:xyz}    	| error       	| error             	| \{a:”10”,b:”xyz”}  	| error                 	| '\{“a”: 10, “b”: “xyz”}'|
 |     choice(0,1)    	| choice(0,1) 	| choice(0.0,1.0)   	| choice(“0”,“1”)   	| choice(false,true)    	| choice(“0”, “1”)       |
 |     choice(a,b)    	| error       	| error             	| choice(“a”,”b”)   	| error                 	| choice('“a”', '“b”')   |
 |     choice(1,a)    	| error       	| error             	| choice(“1”,”a”)   	| error                 	| choice(“1”, '“a”')     |

website/docs/advanced/override_grammar/extended.md

@@ -66,7 +66,7 @@ name: sqlite
 
 
 ### An example using only default packages
-The default package of *config.yaml* is the global package, of *server/apache.yaml* is *server* and of *server/db/mysql.yaml* is *server.db*. 
+The default package of *config.yaml* is the global package, of *server/apache.yaml* is *server* and of *server/db/mysql.yaml* is *server.db*.
 <div className="row">
 <div className="col col--6">
 
@@ -80,8 +80,8 @@ debug: false
 </div></div>
 
 ### Overriding packages using the Defaults List
-By default, packages specified in the Defaults List are relative to the package of containing config. 
-As a consequence, overriding a package relocates the entire subtree. 
+By default, packages specified in the Defaults List are relative to the package of containing config.
+As a consequence, overriding a package relocates the entire subtree.
 
 <div className="row">
 <div className="col col--4">
@@ -119,17 +119,17 @@ Note that content of *server/apache.yaml* is relocated to *admin*
 and the content of *server/db/mysql.yaml* to *admin.backup*.
 
 #### Default List package keywords
-We will use this example, replacing *<@PACKAGE>* to demonstrate different cases:
+We will use this example, replacing *\<\@PACKAGE>* to demonstrate different cases:
 ```yaml title="config_group/config.yaml"
 defaults:
   - /server/db<@PACKAGE>: mysql
 ```
 
-Without a package override, the resulting package is `config_group.server.db`.  
-With the **@\_here\_** keyword, The resulting package is the same as the containing config (`config_group`). 
+Without a package override, the resulting package is `config_group.server.db`.
+With the **@\_here\_** keyword, The resulting package is the same as the containing config (`config_group`).
 ##### Absolute keywords:
 * **@\_group\_**: \_group\_ is the absolute default package of the config (`server.db`)
-* **@\_global\_**: The global package. Anything following \_global\_ is absolute.  
+* **@\_global\_**: The global package. Anything following \_global\_ is absolute.
   e.g. **@\_global\_.foo** becomes `foo`.
 
 ### Overriding the package via the package directive
@@ -172,4 +172,3 @@ src:
 dst:
   name: mysql
 ```
-