Fix docs url across the repo (facebookresearch#2332)

Co-authored-by: Dhanvanth <[email protected]>
Co-authored-by: Jasha <[email protected]>

NEWS.md

@@ -31,19 +31,19 @@
 - If user code raises an exception when called by `instantiate`, raise an `InstantiateError` exception instead of an instance of the same exception class that was raised by the user code. ([#1911](https://github.com/facebookresearch/hydra/issues/1911))
 - Remove support for deprecated arg `config_loader` to Plugin.setup, and update signature of `run_job` to require `hydra_context`. ([#1953](https://github.com/facebookresearch/hydra/issues/1953))
 
-The remaining changes are protected by the new [version_base](https://hydra.cc/docs/next/upgrades/version_base/) support,
+The remaining changes are protected by the new [version_base](https://hydra.cc/docs/upgrades/version_base/) support,
 which allows one to either configure Hydra to support older setups / config, or configure Hydra to use the following more modern defaults:
 
 - Remove deprecated "old optional" defaults list syntax ([#1952](https://github.com/facebookresearch/hydra/issues/1952))
 - Remove support for the legacy hydra override syntax (see [deprecation notice](https://hydra.cc/docs/upgrades/1.0_to_1.1/defaults_list_override/)). ([#2056](https://github.com/facebookresearch/hydra/issues/2056))
 - Remove support for old hydra.experimental.{compose,initialize} interface
-- Remove support for `_name_` and `_group_` from package header (see [deprecation notice](https://hydra.cc/docs/next/upgrades/1.0_to_1.1/changes_to_package_header))
-- Remove support for legacy default list interpolation format (see [deprecation notice](http://hydra.cc/docs/next/upgrades/1.0_to_1.1/defaults_list_interpolation))
+- Remove support for `_name_` and `_group_` from package header (see [deprecation notice](https://hydra.cc/docs/upgrades/1.0_to_1.1/changes_to_package_header))
+- Remove support for legacy default list interpolation format (see [deprecation notice](http://hydra.cc/docs/upgrades/1.0_to_1.1/defaults_list_interpolation))
 - Remove support for TargetConf class
 - Remove support for strict flag from compose API (see [deprecation notice](https://hydra.cc/docs/upgrades/0.11_to_1.0/strict_mode_flag_deprecated))
 - Remove support for "*.yml" extensions, requiring "*.yaml" instead.
 - Default to not changing the working directory at runtime. Use `hydra.job.chdir=True` to reinstate old behavior.
-- Default to not adding any directory to the config path. (see [`config_path` options](https://hydra.cc/docs/next/upgrades/1.0_to_1.1/changes_to_hydra_main_config_path))
+- Default to not adding any directory to the config path. (see [`config_path` options](https://hydra.cc/docs/upgrades/1.0_to_1.1/changes_to_hydra_main_config_path))
 
 
 1.1.1 (2021-08-19)
@@ -109,7 +109,7 @@ Please check the API changes and deprecation sections in these release notes and
 
 ### API Change (Renames, deprecations and removals)
 #### General changes
-- Default composition order change, see [this](https://hydra.cc/docs/next/upgrades/1.0_to_1.1/default_composition_order) for details ([#1217](https://github.com/facebookresearch/hydra/issues/1217))
+- Default composition order change, see [this](https://hydra.cc/docs/upgrades/1.0_to_1.1/default_composition_order) for details ([#1217](https://github.com/facebookresearch/hydra/issues/1217))
 - Remove deprecated strict flag from `@hydra.main` and the `Compose API` ([#1010](https://github.com/facebookresearch/hydra/issues/1010))
 - Passing a config name as config_path to `@hydra.main` is now an error ([#1010](https://github.com/facebookresearch/hydra/issues/1010))
 - Promote `hydra.experimental.{compose,initialize,initialize_config_dir,initialize_config_module}` out from the `hydra.experimental` module to the hydra module. ([#1030](https://github.com/facebookresearch/hydra/issues/1030))
@@ -144,10 +144,10 @@ Please check the API changes and deprecation sections in these release notes and
 
 ### Improved Documentation
 
-- New Defaults List [page](https://hydra.cc/docs/next/advanced/defaults_list) ([#1170](https://github.com/facebookresearch/hydra/issues/1170))
-- New [Extending Configs](https://hydra.cc/docs/next/patterns/extending_configs/) pattern ([#1170](https://github.com/facebookresearch/hydra/issues/1170))
-- Major updates to the [Packages](https://hydra.cc/docs/next/advanced/overriding_packages) page ([#1170](https://github.com/facebookresearch/hydra/issues/1170))
-- New [Configuring Experiments](https://hydra.cc/docs/next/patterns/configuring_experiments/) pattern ([#1170](https://github.com/facebookresearch/hydra/issues/1170))
+- New Defaults List [page](https://hydra.cc/docs/advanced/defaults_list) ([#1170](https://github.com/facebookresearch/hydra/issues/1170))
+- New [Extending Configs](https://hydra.cc/docs/patterns/extending_configs/) pattern ([#1170](https://github.com/facebookresearch/hydra/issues/1170))
+- Major updates to the [Packages](https://hydra.cc/docs/advanced/overriding_packages) page ([#1170](https://github.com/facebookresearch/hydra/issues/1170))
+- New [Configuring Experiments](https://hydra.cc/docs/patterns/configuring_experiments/) pattern ([#1170](https://github.com/facebookresearch/hydra/issues/1170))
 - Documentation updates for configuring search path ([#1449](https://github.com/facebookresearch/hydra/issues/1449))
 - Documentation for `hydra.callbacks` ([#1526](https://github.com/facebookresearch/hydra/issues/1526))
 - Document how to configure Hydra plugins ([#1582](https://github.com/facebookresearch/hydra/issues/1582))
@@ -326,7 +326,7 @@ Be aware that `cfg.pretty()` is now deprecated and you should use `OmegaConf.to_
 
 ### API Change (Renames, deprecations and removals)
 
-- ObjectConf is deprecated for TargetConf. See [upgrade page](https://hydra.cc/docs/next/upgrades/0.11_to_1.0/object_instantiation_changes). ([#882](https://github.com/facebookresearch/hydra/issues/882))
+- ObjectConf is deprecated for TargetConf. See [upgrade page](https://hydra.cc/docs/upgrades/0.11_to_1.0/object_instantiation_changes). ([#882](https://github.com/facebookresearch/hydra/issues/882))
 - All plugins updated to use TargetConf. Be sure to update all your Hydra plugins ([#882](https://github.com/facebookresearch/hydra/issues/882))
 - Instantiated objects no longer have a params node in the conf. keys like hydra.launcher.params.foo are changed to hydra.launcher.foo. Update your configs and overrides if you were overriding such parameters. ([#882](https://github.com/facebookresearch/hydra/issues/882))
 
@@ -380,10 +380,10 @@ Be aware that `cfg.pretty()` is now deprecated and you should use `OmegaConf.to_
 ### Improved Documentation
 
 - Add a unit testing example in the [Hydra example application](https://github.com/facebookresearch/hydra/blob/master/examples/advanced/hydra_app_example/tests/test_example.py) ([#687](https://github.com/facebookresearch/hydra/issues/687))
-- New [Terminology](https://hydra.cc/docs/next/terminology) page ([#795](https://github.com/facebookresearch/hydra/issues/795))
-- New [Advanced/Hydra in Jupyter Notebooks](https://hydra.cc/docs/next/advanced/jupyter_notebooks) page ([#795](https://github.com/facebookresearch/hydra/issues/795))
-- New [Advanced/Hydra in Unit Tests](https://hydra.cc/docs/next/advanced/unit_testing) page ([#795](https://github.com/facebookresearch/hydra/issues/795))
-- New [Advanced/Override Grammar/Basic](https://hydra.cc/docs/next/advanced/override_grammar/basic) page ([#795](https://github.com/facebookresearch/hydra/issues/795))
+- New [Terminology](https://hydra.cc/docs/terminology) page ([#795](https://github.com/facebookresearch/hydra/issues/795))
+- New [Advanced/Hydra in Jupyter Notebooks](https://hydra.cc/docs/advanced/jupyter_notebooks) page ([#795](https://github.com/facebookresearch/hydra/issues/795))
+- New [Advanced/Hydra in Unit Tests](https://hydra.cc/docs/advanced/unit_testing) page ([#795](https://github.com/facebookresearch/hydra/issues/795))
+- New [Advanced/Override Grammar/Basic](https://hydra.cc/docs/advanced/override_grammar/basic) page ([#795](https://github.com/facebookresearch/hydra/issues/795))
 
 ### Maintenance Changes
 

examples/jupyter_notebooks/compose_configs_in_notebook.ipynb

@@ -28,7 +28,7 @@
    "metadata": {},
    "source": [
     "# Initializing Hydra\n",
-    "There are several ways to initialize. See the [API docs](https://hydra.cc/docs/next/advanced/compose_api/#api-documentation) for full details.\n",
+    "There are several ways to initialize. See the [API docs](https://hydra.cc/docs/advanced/compose_api/#api-documentation) for full details.\n",
     "All methods support both a function call style that changes the global state, and a context style that cleans up when the scope exits.\n",
     "\n",
     "## initialize()\n",

hydra/_internal/config_loader_impl.py

@@ -419,7 +419,7 @@ def _load_single_config(
 
             if schema is not None:
                 try:
-                    url = "https://hydra.cc/docs/next/upgrades/1.0_to_1.1/automatic_schema_matching"
+                    url = "https://hydra.cc/docs/upgrades/1.0_to_1.1/automatic_schema_matching"
                     if "defaults" in schema.config:
                         raise ConfigCompositionException(
                             dedent(

hydra/_internal/config_repository.py

@@ -178,7 +178,7 @@ def _create_defaults_list(
     ) -> List[InputDefault]:
         def issue_deprecated_name_warning() -> None:
             # DEPRECATED: remove in 1.2
-            url = "https://hydra.cc/docs/next/upgrades/1.0_to_1.1/changes_to_package_header"
+            url = "https://hydra.cc/docs/upgrades/1.0_to_1.1/changes_to_package_header"
             deprecation_warning(
                 message=dedent(
                     f"""\

hydra/_internal/core_plugins/zsh_completion.py

@@ -33,7 +33,7 @@ def help(command: str) -> str:
         assert command in ["install", "uninstall"]
         extra_description = (
             "Zsh is compatible with the Bash shell completion, see the [documentation]"
-            "(https://hydra.cc/docs/next/tutorials/basic/running_your_app/tab_completion#zsh-instructions)"
+            "(https://hydra.cc/docs/tutorials/basic/running_your_app/tab_completion#zsh-instructions)"
             " for details.\n    "
         )
         command_text = f'eval "$({{}} -sc {command}=bash)"'

hydra/_internal/defaults_list.py

@@ -404,7 +404,7 @@ def _update_overrides(
         if isinstance(d, GroupDefault):
             if legacy_hydra_override:
                 d.override = True
-                url = "https://hydra.cc/docs/next/upgrades/1.0_to_1.1/defaults_list_override"
+                url = "https://hydra.cc/docs/upgrades/1.0_to_1.1/defaults_list_override"
                 msg = dedent(
                     f"""\
                     In {parent.get_config_path()}: Invalid overriding of {d.group}:

hydra/core/default_element.py

@@ -120,7 +120,7 @@ def set_package_header(self, package_header: Optional[str]) -> None:
         if not version.base_at_least("1.2"):
             if "_group_" in package_header or "_name_" in package_header:
                 path = self.get_config_path()
-                url = "https://hydra.cc/docs/next/upgrades/1.0_to_1.1/changes_to_package_header"
+                url = "https://hydra.cc/docs/upgrades/1.0_to_1.1/changes_to_package_header"
                 deprecation_warning(
                     message=dedent(
                         f"""\
@@ -546,7 +546,7 @@ def resolve_interpolation(self, known_choices: DictConfig) -> None:
                 msg = dedent(
                     f"""
 Defaults list element '{self.get_override_key()}={name}' is using a deprecated interpolation form.
-See http://hydra.cc/docs/next/upgrades/1.0_to_1.1/defaults_list_interpolation for migration information."""
+See http://hydra.cc/docs/1.1/upgrades/1.0_to_1.1/defaults_list_interpolation for migration information."""
                 )
                 if not version.base_at_least("1.2"):
                     deprecation_warning(

hydra/core/override_parser/overrides_parser.py

@@ -96,7 +96,7 @@ def parse_overrides(self, overrides: List[str]) -> List[Override]:
                 raise OverrideParseException(
                     override=override,
                     message=f"{msg}"
-                    f"\nSee https://hydra.cc/docs/next/advanced/override_grammar/basic for details",
+                    f"\nSee https://hydra.cc/docs/advanced/override_grammar/basic for details",
                 ) from e.__cause__
             assert isinstance(parsed, Override)
             parsed.config_loader = self.config_loader

hydra/core/override_parser/types.py

@@ -485,7 +485,7 @@ def get_value_element_as_str(self, space_after_sep: bool = False) -> str:
     def validate(self) -> None:
         if not version.base_at_least("1.2"):
             if self.package is not None and "_name_" in self.package:
-                url = "https://hydra.cc/docs/next/upgrades/1.0_to_1.1/changes_to_package_header"
+                url = "https://hydra.cc/docs/upgrades/1.0_to_1.1/changes_to_package_header"
                 deprecation_warning(
                     message=dedent(
                         f"""\

hydra/core/utils.py

@@ -152,7 +152,9 @@ def run_job(
                 _chdir = False
 
         if _chdir is None:
-            url = "https://hydra.cc/docs/next/upgrades/1.1_to_1.2/changes_to_job_working_dir/"
+            url = (
+                "https://hydra.cc/docs/upgrades/1.1_to_1.2/changes_to_job_working_dir/"
+            )
             deprecation_warning(
                 message=dedent(
                     f"""\
@@ -287,7 +289,7 @@ def validate_config_path(config_path: Optional[str]) -> None:
             msg = dedent(
                 """\
             Using config_path to specify the config name is not supported, specify the config name via config_name.
-            See https://hydra.cc/docs/next/upgrades/0.11_to_1.0/config_path_changes
+            See https://hydra.cc/docs/upgrades/0.11_to_1.0/config_path_changes
             """
             )
             raise ValueError(msg)

hydra/initialize.py

@@ -65,7 +65,7 @@ def __init__(
             if version.base_at_least("1.2"):
                 config_path = None
             elif version_base is _UNSPECIFIED_:
-                url = "https://hydra.cc/docs/next/upgrades/1.0_to_1.1/changes_to_hydra_main_config_path"
+                url = "https://hydra.cc/docs/upgrades/1.0_to_1.1/changes_to_hydra_main_config_path"
                 deprecation_warning(
                     message=dedent(
                         f"""\

hydra/main.py

@@ -59,7 +59,7 @@ def main(
         if version.base_at_least("1.2"):
             config_path = None
         elif version_base is _UNSPECIFIED_:
-            url = "https://hydra.cc/docs/next/upgrades/1.0_to_1.1/changes_to_hydra_main_config_path"
+            url = "https://hydra.cc/docs/upgrades/1.0_to_1.1/changes_to_hydra_main_config_path"
             deprecation_warning(
                 message=dedent(
                     f"""

plugins/hydra_ax_sweeper/README.md

@@ -1,4 +1,4 @@
 # Hydra Ax Sweeper
 Provides a [`Ax Sweeper`](https://ax.dev/) based Hydra Sweeper supporting parallel execution.
 
-See [website](https://hydra.cc/docs/next/plugins/ax_sweeper/) for more information
+See [website](https://hydra.cc/docs/plugins/ax_sweeper/) for more information

plugins/hydra_joblib_launcher/README.md

@@ -1,4 +1,4 @@
 # Hydra Joblib Launcher
 Provides a [`Joblib.Parallel`](https://joblib.readthedocs.io/en/latest/parallel.html) based Hydra Launcher supporting parallel execution.
 
-See [website](https://hydra.cc/docs/next/plugins/joblib_launcher) for more information
+See [website](https://hydra.cc/docs/plugins/joblib_launcher) for more information

plugins/hydra_nevergrad_sweeper/README.md

@@ -2,4 +2,4 @@
 
 Provides a mechanism for Hydra applications to use [Nevergrad](https://github.com/facebookresearch/nevergrad) algorithms for the optimization of the parameters of any experiment.
 
-See [website](https://hydra.cc/docs/next/plugins/nevergrad_sweeper) for more information
+See [website](https://hydra.cc/docs/plugins/nevergrad_sweeper) for more information

plugins/hydra_optuna_sweeper/NEWS.md

@@ -37,4 +37,4 @@
 
 ### API Change (Renames, deprecations and removals)
 
-- Config structure changes, please refer to the [docs](https://hydra.cc/docs/next/plugins/optuna_sweeper/) ([#1472](https://github.com/facebookresearch/hydra/issues/1472))
+- Config structure changes, please refer to the [docs](https://hydra.cc/docs/plugins/optuna_sweeper/) ([#1472](https://github.com/facebookresearch/hydra/issues/1472))

plugins/hydra_optuna_sweeper/README.md

@@ -2,4 +2,4 @@
 
 Provides an [Optuna](https://optuna.org) based Hydra Sweeper.
 
-See [website](https://hydra.cc/docs/next/plugins/optuna_sweeper/) for more information.
+See [website](https://hydra.cc/docs/plugins/optuna_sweeper/) for more information.

plugins/hydra_optuna_sweeper/hydra_plugins/hydra_optuna_sweeper/_impl.py

@@ -180,9 +180,7 @@ def __init__(
         self.search_space_distributions: Optional[Dict[str, BaseDistribution]] = None
 
     def _process_searchspace_config(self) -> None:
-        url = (
-            "https://hydra.cc/docs/next/upgrades/1.1_to_1.2/changes_to_sweeper_config/"
-        )
+        url = "https://hydra.cc/docs/upgrades/1.1_to_1.2/changes_to_sweeper_config/"
         if self.params is None and self.search_space is None:
             self.params = OmegaConf.create({})
         elif self.search_space is not None:

plugins/hydra_ray_launcher/README.md

@@ -1,4 +1,4 @@
 # Hydra Ray Launcher
 Provides a [`Ray`](https://docs.ray.io/en/latest/) based Hydra Launcher supporting execution on AWS.
 
-See [website](https://hydra.cc/docs/next/plugins/ray_launcher) for more information
+See [website](https://hydra.cc/docs/plugins/ray_launcher) for more information

plugins/hydra_rq_launcher/README.md

@@ -1,4 +1,4 @@
 # Hydra RQ Launcher
 Provides a [Redis Queue (RQ)](https://python-rq.org) launcher for Hydra supporting distributed execution and job queuing.
 
-See [website](https://hydra.cc/docs/next/plugins/rq_launcher) for more information
+See [website](https://hydra.cc/docs/plugins/rq_launcher) for more information

plugins/hydra_submitit_launcher/README.md

@@ -1,4 +1,4 @@
 # Hydra Submitit Launcher
 Provides a [`Submitit`](https://github.com/facebookincubator/submitit) based Hydra Launcher supporting [SLURM ](https://slurm.schedmd.com/documentation.html).
 
-See [website](https://hydra.cc/docs/next/plugins/submitit_launcher) for more information
+See [website](https://hydra.cc/docs/plugins/submitit_launcher) for more information

tests/defaults_list/test_defaults_list.py

@@ -910,7 +910,7 @@ def test_include_nested_group_name_(
     expected: List[ResultDefault],
     warning_file: str,
 ) -> None:
-    url = "https://hydra.cc/docs/next/upgrades/1.0_to_1.1/changes_to_package_header"
+    url = "https://hydra.cc/docs/upgrades/1.0_to_1.1/changes_to_package_header"
     msg = f"In {warning_file}: Defaults List contains deprecated keyword _name_, see {url}\n"
 
     with warns(UserWarning, match=re.escape(msg)):

tests/defaults_list/test_defaults_tree.py

@@ -946,7 +946,7 @@ def test_legacy_override_hydra_version_base_1_1(
         """\
         Invalid overriding of hydra/help:
         Default list overrides requires 'override' keyword.
-        See https://hydra.cc/docs/next/upgrades/1.0_to_1.1/defaults_list_override for more information."""
+        See https://hydra.cc/docs/upgrades/1.0_to_1.1/defaults_list_override for more information."""
     )
     with warns(expected_warning=UserWarning, match=re.escape(msg)):
         _test_defaults_tree_impl(
@@ -2024,7 +2024,7 @@ def test_legacy_interpolation(
     msg = dedent(
         """
     Defaults list element '.*=.*' is using a deprecated interpolation form.
-    See http://hydra.cc/docs/next/upgrades/1.0_to_1.1/defaults_list_interpolation for migration information."""
+    See http://hydra.cc/docs/1.1/upgrades/1.0_to_1.1/defaults_list_interpolation for migration information."""
     )
     version.setbase("1.1")
     with warns(expected_warning=UserWarning, match=msg):
@@ -2839,7 +2839,7 @@ def test_deprecated_package_header_keywords(
     msg = dedent(
         f"""\
         In '{config_name}': Usage of deprecated keyword in package header '# @package {package_header}'.
-        See https://hydra.cc/docs/next/upgrades/1.0_to_1.1/changes_to_package_header for more information"""
+        See https://hydra.cc/docs/upgrades/1.0_to_1.1/changes_to_package_header for more information"""
     )
 
     version.setbase("1.1")

tests/test_compose.py

@@ -730,7 +730,7 @@ def test_initialize_without_config_path(tmpdir: Path) -> None:
     expected = dedent(
         """\
         config_path is not specified in hydra.initialize().
-        See https://hydra.cc/docs/next/upgrades/1.0_to_1.1/changes_to_hydra_main_config_path for more information."""
+        See https://hydra.cc/docs/upgrades/1.0_to_1.1/changes_to_hydra_main_config_path for more information."""
     )
     with warns(expected_warning=UserWarning, match=re.escape(expected)):
         with initialize():