From f363b22477f4dc4134b1fbd92ce7482bc4f4114e Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Tue, 6 Aug 2024 17:16:59 +1200 Subject: [PATCH] Move packages and substitutions out of folders (#4112) * Move packages and substitutions out of folders * Fix --- changelog/v1.10.0.rst | 2 +- components/index.rst | 2 -- components/{packages/index.rst => packages.rst} | 2 +- components/{substitutions/index.rst => substitutions.rst} | 0 guides/faq.rst | 4 ++-- index.rst | 4 ++-- 6 files changed, 6 insertions(+), 8 deletions(-) rename components/{packages/index.rst => packages.rst} (98%) rename components/{substitutions/index.rst => substitutions.rst} (100%) diff --git a/changelog/v1.10.0.rst b/changelog/v1.10.0.rst index b31f91710..95cf07b88 100644 --- a/changelog/v1.10.0.rst +++ b/changelog/v1.10.0.rst @@ -134,7 +134,7 @@ Other notable changes: (:ref:`wifi-networks`) - GPIO Switches have a new option ``restore_mode`` to configure how their values should be restored on boot. (:doc:`/components/switch/gpio`) -- Added :doc:`/components/substitutions/index` to reduce repeating across configs. +- Added :doc:`/components/substitutions` to reduce repeating across configs. - Validation error messages are now displayed even better. Now all errors are shown with the exact context where the error appeared. Try it, it's so much better. Next step will be to upgrade to a better YAML reader to provide better error messages when the YAML syntax is invalid. diff --git a/components/index.rst b/components/index.rst index fb1f9a27a..f937b80a2 100644 --- a/components/index.rst +++ b/components/index.rst @@ -34,6 +34,4 @@ Components text/index update/index valve/index - packages/index - substitutions/index * diff --git a/components/packages/index.rst b/components/packages.rst similarity index 98% rename from components/packages/index.rst rename to components/packages.rst index 1973730aa..1a23253c0 100644 --- a/components/packages/index.rst +++ b/components/packages.rst @@ -74,7 +74,7 @@ Remote/Git Packages ------------------- Packages can also be loaded from a Git repository by utilizing the correct configuration syntax. -:doc:`/components/substitutions/index` can be used inside the remote packages which allows users to override +:doc:`/components/substitutions` can be used inside the remote packages which allows users to override them locally with their own substitution value. .. note:: diff --git a/components/substitutions/index.rst b/components/substitutions.rst similarity index 100% rename from components/substitutions/index.rst rename to components/substitutions.rst diff --git a/guides/faq.rst b/guides/faq.rst index 69044a2b3..105bb011e 100644 --- a/guides/faq.rst +++ b/guides/faq.rst @@ -48,7 +48,7 @@ Tips for using ESPHome payload: double - For even more configuration templating, take a look at :doc:`/components/substitutions/index`. + For even more configuration templating, take a look at :doc:`/components/substitutions`. 2. If you want to see how ESPHome interprets your configuration, run @@ -66,7 +66,7 @@ Tips for using ESPHome 5. You can view the full list of command line interface options here: :doc:`/guides/cli` -6. Use :doc:`/components/substitutions/index` to reduce repetition in your configuration files. +6. Use :doc:`/components/substitutions` to reduce repetition in your configuration files. .. |secret| replace:: ``!secret`` .. _secret: https://www.home-assistant.io/docs/configuration/secrets/ diff --git a/index.rst b/index.rst index a125265a0..3aea2682d 100644 --- a/index.rst +++ b/index.rst @@ -182,8 +182,8 @@ Streamline your ESPHome configuration and/or use components provided by other co .. imgtable:: External Components, components/external_components, external_components.svg, dark-invert - Packages, components/packages/index, description.svg, dark-invert - Substitutions, components/substitutions/index, description.svg, dark-invert + Packages, components/packages, description.svg, dark-invert + Substitutions, components/substitutions, description.svg, dark-invert Network Hardware ----------------