diff --git a/docs/envvars.rst b/docs/envvars.rst index ec8fd586..765ec0a3 100644 --- a/docs/envvars.rst +++ b/docs/envvars.rst @@ -85,36 +85,36 @@ Allows to override PlatformIO settings. You can manage them via PLATFORMIO_SETTING_AUTO_UPDATE_LIBRARIES ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Allows to override setting :option:`auto_update_libraries`. +Allows to override setting :ref:`setting_auto_update_libraries`. PLATFORMIO_SETTING_AUTO_UPDATE_PLATFORMS ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Allows to override setting :option:`auto_update_platforms`. +Allows to override setting :ref:`setting_auto_update_platforms`. PLATFORMIO_SETTING_CHECK_LIBRARIES_INTERVAL ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Allows to override setting :option:`check_libraries_interval`. +Allows to override setting :ref:`setting_check_libraries_interval`. PLATFORMIO_SETTING_CHECK_PLATFORMIO_INTERVAL ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Allows to override setting :option:`check_platformio_interval`. +Allows to override setting :ref:`setting_check_platformio_interval`. PLATFORMIO_SETTING_CHECK_PLATFORMS_INTERVAL ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Allows to override setting :option:`check_platforms_interval`. +Allows to override setting :ref:`setting_check_platforms_interval`. .. _envvar_PLATFORMIO_SETTING_ENABLE_PROMPTS: PLATFORMIO_SETTING_ENABLE_PROMPTS ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Allows to override setting :option:`enable_prompts`. +Allows to override setting :ref:`setting_enable_prompts`. PLATFORMIO_SETTING_ENABLE_TELEMETRY ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Allows to override setting :option:`enable_telemetry`. +Allows to override setting :ref:`setting_enable_telemetry`. diff --git a/docs/userguide/cmd_settings.rst b/docs/userguide/cmd_settings.rst index 4fe14304..d1355dcf 100644 --- a/docs/userguide/cmd_settings.rst +++ b/docs/userguide/cmd_settings.rst @@ -23,45 +23,63 @@ Description Get/List existing settings -Options -~~~~~~~ +Settings +~~~~~~~~ -.. option:: auto_update_libraries +.. _setting_auto_update_libraries: + +``auto_update_libraries`` +^^^^^^^^^^^^^^^^^^^^^^^^^ :Default: Yes :Values: Yes/No Automatically update libraries. -.. option:: auto_update_platforms +.. _setting_auto_update_platforms: + +``auto_update_platforms`` +^^^^^^^^^^^^^^^^^^^^^^^^^ :Default: Yes :Values: Yes/No Automatically update platforms. -.. option:: check_libraries_interval +.. _setting_check_libraries_interval: + +``check_libraries_interval`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :Default: 7 :Values: Days (Number) Check for the library updates interval. -.. option:: check_platformio_interval +.. _setting_check_platformio_interval: + +``check_platformio_interval`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :Default: 3 :Values: Days (Number) Check for the new PlatformIO interval. -.. option:: check_platforms_interval +.. _setting_check_platforms_interval: + +``check_platforms_interval`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :Default: 7 :Values: Days (Number) Check for the platform updates interval. -.. option:: enable_prompts +.. _setting_enable_prompts: + +``enable_prompts`` +^^^^^^^^^^^^^^^^^^ :Default: Yes :Values: Yes/No @@ -76,7 +94,10 @@ Can PlatformIO communicate with you via prompts? If you are going to run *PlatformIO* from **subprocess**, you **MUST DISABLE** all prompts. It will allow you to avoid blocking. -.. option:: enable_telemetry +.. _setting_enable_telemetry: + +``enable_telemetry`` +^^^^^^^^^^^^^^^^^^^^ :Default: Yes :Values: Yes/No