From b41078cc466973e67128d44269ac3d4b2f6f6815 Mon Sep 17 00:00:00 2001 From: Matthias Date: Tue, 2 Feb 2021 20:23:30 +0100 Subject: [PATCH] Don't include plugin documentation in Configuration page --- docs/backtesting.md | 2 +- docs/configuration.md | 6 ++---- docs/developer.md | 2 +- docs/utils.md | 4 ++-- 4 files changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/backtesting.md b/docs/backtesting.md index 15b189ebf..a14c8f2e4 100644 --- a/docs/backtesting.md +++ b/docs/backtesting.md @@ -103,7 +103,7 @@ The result of backtesting will confirm if your bot has better odds of making a p !!! Warning "Using dynamic pairlists for backtesting" Using dynamic pairlists is possible, however it relies on the current market conditions - which will not reflect the historic status of the pairlist. Also, when using pairlists other than StaticPairlist, reproducability of backtesting-results cannot be guaranteed. - Please read the [pairlists documentation](configuration.md#pairlists) for more information. + Please read the [pairlists documentation](plugins.md#pairlists) for more information. To achieve reproducible results, best generate a pairlist via the [`test-pairlist`](utils.md#test-pairlist) command and use that as static pairlist. diff --git a/docs/configuration.md b/docs/configuration.md index 06619b301..e5eac973f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -91,8 +91,8 @@ Mandatory parameters are marked as **Required**, which means that they are requi | `exchange.skip_pair_validation` | Skip pairlist validation on startup.
*Defaults to `false`
**Datatype:** Boolean | `edge.*` | Please refer to [edge configuration document](edge.md) for detailed explanation. | `experimental.block_bad_exchanges` | Block exchanges known to not work with freqtrade. Leave on default unless you want to test if that exchange works now.
*Defaults to `true`.*
**Datatype:** Boolean -| `pairlists` | Define one or more pairlists to be used. [More information below](#pairlists-and-pairlist-handlers).
*Defaults to `StaticPairList`.*
**Datatype:** List of Dicts -| `protections` | Define one or more protections to be used. [More information below](#protections). [Strategy Override](#parameters-in-the-strategy).
**Datatype:** List of Dicts +| `pairlists` | Define one or more pairlists to be used. [More information](plugins.md#pairlists-and-pairlist-handlers).
*Defaults to `StaticPairList`.*
**Datatype:** List of Dicts +| `protections` | Define one or more protections to be used. [More information](plugins.md#protections). [Strategy Override](#parameters-in-the-strategy).
**Datatype:** List of Dicts | `telegram.enabled` | Enable the usage of Telegram.
**Datatype:** Boolean | `telegram.token` | Your Telegram bot token. Only required if `telegram.enabled` is `true`.
**Keep it in secret, do not disclose publicly.**
**Datatype:** String | `telegram.chat_id` | Your personal Telegram account id. Only required if `telegram.enabled` is `true`.
**Keep it in secret, do not disclose publicly.**
**Datatype:** String @@ -575,8 +575,6 @@ Assuming both buy and sell are using market orders, a configuration similar to t ``` Obviously, if only one side is using limit orders, different pricing combinations can be used. ---8<-- "includes/pairlists.md" ---8<-- "includes/protections.md" ## Using Dry-run mode diff --git a/docs/developer.md b/docs/developer.md index 831d9d2f8..c09e528bf 100644 --- a/docs/developer.md +++ b/docs/developer.md @@ -177,7 +177,7 @@ In `VolumePairList`, this implements different methods of sorting, does early va ### Protections -Best read the [Protection documentation](configuration.md#protections) to understand protections. +Best read the [Protection documentation](plugins.md#protections) to understand protections. This Guide is directed towards Developers who want to develop a new protection. No protection should use datetime directly, but use the provided `date_now` variable for date calculations. This preserves the ability to backtest protections. diff --git a/docs/utils.md b/docs/utils.md index 409bcc134..cf7d5f1d1 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -391,7 +391,7 @@ $ freqtrade list-markets --exchange kraken --all ## Test pairlist -Use the `test-pairlist` subcommand to test the configuration of [dynamic pairlists](configuration.md#pairlists). +Use the `test-pairlist` subcommand to test the configuration of [dynamic pairlists](plugins.md#pairlists). Requires a configuration with specified `pairlists` attribute. Can be used to generate static pairlists to be used during backtesting / hyperopt. @@ -415,7 +415,7 @@ optional arguments: ### Examples -Show whitelist when using a [dynamic pairlist](configuration.md#pairlists). +Show whitelist when using a [dynamic pairlist](plugins.md#pairlists). ``` freqtrade test-pairlist --config config.json --quote USDT BTC