aherman
/
freqtrade
mirror of https://github.com/freqtrade/freqtrade.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: update doc links from latest to stable

Browse Source
pull/12819/head
Matthias 6 days ago
parent 655d61e560
commit d29d4cba66
6 changed files with 39 additions and 39 deletions
Show Stats Download Patch File Download Diff File

30
freqtrade/strategy/interface.py
Unescape View File

@ -367,7 +367,7 @@ class IStrategy(ABC, HyperStrategyMixin):
Timing for this function is critical, so avoid doing heavy computations or
network requests in this method.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-advanced/
When not implemented by a strategy, returns True (always confirming).
@ -403,7 +403,7 @@ class IStrategy(ABC, HyperStrategyMixin):
Timing for this function is critical, so avoid doing heavy computations or
network requests in this method.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-advanced/
When not implemented by a strategy, returns True (always confirming).
@ -453,7 +453,7 @@ class IStrategy(ABC, HyperStrategyMixin):
e.g. returning -0.05 would create a stoploss 5% below current_rate.
The custom stoploss can never be below self.stoploss, which serves as a hard maximum loss.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-advanced/
When not implemented by a strategy, returns the initial stoploss value.
Only called when use_custom_stoploss is set to True.
@ -511,7 +511,7 @@ class IStrategy(ABC, HyperStrategyMixin):
"""
Custom entry price logic, returning the new entry price.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-advanced/
When not implemented by a strategy, returns None, orderbook is used to set entry price
@ -539,7 +539,7 @@ class IStrategy(ABC, HyperStrategyMixin):
"""
Custom exit price logic, returning the new exit price.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-advanced/
When not implemented by a strategy, returns None, orderbook is used to set exit price
@ -666,7 +666,7 @@ class IStrategy(ABC, HyperStrategyMixin):
This means extra entry or exit orders with additional fees.
Only called when `position_adjustment_enable` is set to True.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-advanced/
When not implemented by a strategy, returns None
@ -706,7 +706,7 @@ class IStrategy(ABC, HyperStrategyMixin):
This only executes when a order was already placed, still open (unfilled fully or partially)
and not timed out on subsequent candles after entry trigger.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-callbacks/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-callbacks/
When not implemented by a strategy, returns current_order_rate as default.
If current_order_rate is returned then the existing order is maintained.
@ -743,7 +743,7 @@ class IStrategy(ABC, HyperStrategyMixin):
This only executes when a order was already placed, still open (unfilled fully or partially)
and not timed out on subsequent candles after entry trigger.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-callbacks/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-callbacks/
When not implemented by a strategy, returns current_order_rate as default.
If current_order_rate is returned then the existing order is maintained.
@ -781,7 +781,7 @@ class IStrategy(ABC, HyperStrategyMixin):
This only executes when a order was already placed, still open (unfilled fully or partially)
and not timed out on subsequent candles after entry trigger.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-callbacks/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-callbacks/
When not implemented by a strategy, returns current_order_rate as default.
If current_order_rate is returned then the existing order is maintained.
@ -925,9 +925,9 @@ class IStrategy(ABC, HyperStrategyMixin):
More details on how these config defined parameters accelerate feature engineering
in the documentation at:
https://www.freqtrade.io/en/latest/freqai-parameter-table/#feature-parameters
https://www.freqtrade.io/en/stable/freqai-parameter-table/#feature-parameters
https://www.freqtrade.io/en/latest/freqai-feature-engineering/#defining-the-features
https://www.freqtrade.io/en/stable/freqai-feature-engineering/#defining-the-features
:param dataframe: strategy dataframe which will receive the features
:param period: period of the indicator - usage example:
@ -956,9 +956,9 @@ class IStrategy(ABC, HyperStrategyMixin):
More details on how these config defined parameters accelerate feature engineering
in the documentation at:
https://www.freqtrade.io/en/latest/freqai-parameter-table/#feature-parameters
https://www.freqtrade.io/en/stable/freqai-parameter-table/#feature-parameters
https://www.freqtrade.io/en/latest/freqai-feature-engineering/#defining-the-features
https://www.freqtrade.io/en/stable/freqai-feature-engineering/#defining-the-features
:param dataframe: strategy dataframe which will receive the features
:param metadata: metadata of current pair
@ -985,7 +985,7 @@ class IStrategy(ABC, HyperStrategyMixin):
More details about feature engineering available:
https://www.freqtrade.io/en/latest/freqai-feature-engineering
https://www.freqtrade.io/en/stable/freqai-feature-engineering
:param dataframe: strategy dataframe which will receive the features
:param metadata: metadata of current pair
@ -1001,7 +1001,7 @@ class IStrategy(ABC, HyperStrategyMixin):
More details about feature engineering available:
https://www.freqtrade.io/en/latest/freqai-feature-engineering
https://www.freqtrade.io/en/stable/freqai-feature-engineering
:param dataframe: strategy dataframe which will receive the targets
:param metadata: metadata of current pair

12
freqtrade/templates/FreqaiExampleHybridStrategy.py
Unescape View File

@ -113,9 +113,9 @@ class FreqaiExampleHybridStrategy(IStrategy):
More details on how these config defined parameters accelerate feature engineering
in the documentation at:
https://www.freqtrade.io/en/latest/freqai-parameter-table/#feature-parameters
https://www.freqtrade.io/en/stable/freqai-parameter-table/#feature-parameters
https://www.freqtrade.io/en/latest/freqai-feature-engineering/#defining-the-features
https://www.freqtrade.io/en/stable/freqai-feature-engineering/#defining-the-features
:param dataframe: strategy dataframe which will receive the features
:param period: period of the indicator - usage example:
@ -169,9 +169,9 @@ class FreqaiExampleHybridStrategy(IStrategy):
More details on how these config defined parameters accelerate feature engineering
in the documentation at:
https://www.freqtrade.io/en/latest/freqai-parameter-table/#feature-parameters
https://www.freqtrade.io/en/stable/freqai-parameter-table/#feature-parameters
https://www.freqtrade.io/en/latest/freqai-feature-engineering/#defining-the-features
https://www.freqtrade.io/en/stable/freqai-feature-engineering/#defining-the-features
:param dataframe: strategy dataframe which will receive the features
:param metadata: metadata of current pair
@ -201,7 +201,7 @@ class FreqaiExampleHybridStrategy(IStrategy):
More details about feature engineering available:
https://www.freqtrade.io/en/latest/freqai-feature-engineering
https://www.freqtrade.io/en/stable/freqai-feature-engineering
:param dataframe: strategy dataframe which will receive the features
:param metadata: metadata of current pair
@ -219,7 +219,7 @@ class FreqaiExampleHybridStrategy(IStrategy):
More details about feature engineering available:
https://www.freqtrade.io/en/latest/freqai-feature-engineering
https://www.freqtrade.io/en/stable/freqai-feature-engineering
:param dataframe: strategy dataframe which will receive the targets
:param metadata: metadata of current pair

12
freqtrade/templates/FreqaiExampleStrategy.py
Unescape View File

@ -65,9 +65,9 @@ class FreqaiExampleStrategy(IStrategy):
More details on how these config defined parameters accelerate feature engineering
in the documentation at:
https://www.freqtrade.io/en/latest/freqai-parameter-table/#feature-parameters
https://www.freqtrade.io/en/stable/freqai-parameter-table/#feature-parameters
https://www.freqtrade.io/en/latest/freqai-feature-engineering/#defining-the-features
https://www.freqtrade.io/en/stable/freqai-feature-engineering/#defining-the-features
:param dataframe: strategy dataframe which will receive the features
:param period: period of the indicator - usage example:
@ -125,9 +125,9 @@ class FreqaiExampleStrategy(IStrategy):
More details on how these config defined parameters accelerate feature engineering
in the documentation at:
https://www.freqtrade.io/en/latest/freqai-parameter-table/#feature-parameters
https://www.freqtrade.io/en/stable/freqai-parameter-table/#feature-parameters
https://www.freqtrade.io/en/latest/freqai-feature-engineering/#defining-the-features
https://www.freqtrade.io/en/stable/freqai-feature-engineering/#defining-the-features
:param dataframe: strategy dataframe which will receive the features
:param metadata: metadata of current pair
@ -161,7 +161,7 @@ class FreqaiExampleStrategy(IStrategy):
More details about feature engineering available:
https://www.freqtrade.io/en/latest/freqai-feature-engineering
https://www.freqtrade.io/en/stable/freqai-feature-engineering
:param dataframe: strategy dataframe which will receive the features
:param metadata: metadata of current pair
@ -183,7 +183,7 @@ class FreqaiExampleStrategy(IStrategy):
More details about feature engineering available:
https://www.freqtrade.io/en/latest/freqai-feature-engineering
https://www.freqtrade.io/en/stable/freqai-feature-engineering
:param dataframe: strategy dataframe which will receive the targets
:param metadata: metadata of current pair

2
freqtrade/templates/base_strategy.py.j2
Unescape View File

@ -40,7 +40,7 @@ from technical import qtpylib
class {{ strategy }}(IStrategy):
"""
This is a strategy template to get you started.
More information in https://www.freqtrade.io/en/latest/strategy-customization/
More information in https://www.freqtrade.io/en/stable/strategy-customization/
You can:
:return: a Dataframe with all mandatory indicators for the strategies

2
freqtrade/templates/sample_strategy.py
Unescape View File

@ -40,7 +40,7 @@ from technical import qtpylib
class SampleStrategy(IStrategy):
"""
This is a sample strategy to inspire you.
More information in https://www.freqtrade.io/en/latest/strategy-customization/
More information in https://www.freqtrade.io/en/stable/strategy-customization/
You can:
:return: a Dataframe with all mandatory indicators for the strategies

20
freqtrade/templates/strategy_subtemplates/strategy_methods_advanced.j2
Unescape View File

@ -5,7 +5,7 @@ def bot_loop_start(self, current_time: datetime, **kwargs) -> None:
Might be used to perform pair-independent tasks
(e.g. gather some remote resource for comparison)
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-advanced/
When not implemented by a strategy, this simply does nothing.
:param current_time: datetime object, containing the current datetime
@ -26,7 +26,7 @@ def custom_entry_price(
"""
Custom entry price logic, returning the new entry price.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-advanced/
When not implemented by a strategy, returns None, orderbook is used to set entry price
@ -58,7 +58,7 @@ def adjust_order_price(
This only executes when a order was already placed, still open (unfilled fully or partially)
and not timed out on subsequent candles after entry trigger.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-callbacks/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-callbacks/
When not implemented by a strategy, returns current_order_rate as default.
If current_order_rate is returned then the existing order is maintained.
@ -91,7 +91,7 @@ def custom_exit_price(
"""
Custom exit price logic, returning the new exit price.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-advanced/
When not implemented by a strategy, returns None, orderbook is used to set exit price
@ -183,7 +183,7 @@ def custom_stoploss(
e.g. returning -0.05 would create a stoploss 5% below current_rate.
The custom stoploss can never be below self.stoploss, which serves as a hard maximum loss.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-advanced/
When not implemented by a strategy, returns the initial stoploss value.
Only called when use_custom_stoploss is set to True.
@ -246,7 +246,7 @@ def confirm_trade_entry(
Timing for this function is critical, so avoid doing heavy computations or
network requests in this method.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-advanced/
When not implemented by a strategy, returns True (always confirming).
@ -282,7 +282,7 @@ def confirm_trade_exit(
Timing for this function is critical, so avoid doing heavy computations or
network requests in this method.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-advanced/
When not implemented by a strategy, returns True (always confirming).
@ -314,7 +314,7 @@ def check_entry_timeout(
Configuration options in `unfilledtimeout` will be verified before this,
so ensure to set these timeouts high enough.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-advanced/
When not implemented by a strategy, this simply returns False.
:param pair: Pair the trade is for
@ -337,7 +337,7 @@ def check_exit_timeout(
Configuration options in `unfilledtimeout` will be verified before this,
so ensure to set these timeouts high enough.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-advanced/
When not implemented by a strategy, this simply returns False.
:param pair: Pair the trade is for
@ -369,7 +369,7 @@ def adjust_trade_position(
This means extra entry or exit orders with additional fees.
Only called when `position_adjustment_enable` is set to True.
For full documentation please go to https://www.freqtrade.io/en/latest/strategy-advanced/
For full documentation please go to https://www.freqtrade.io/en/stable/strategy-advanced/
When not implemented by a strategy, returns None

Write Preview
Loading…
Cancel
Save