From cd0e813a858660eac36f48ea615ce356e68ae5cb Mon Sep 17 00:00:00 2001 From: hroff-1902 Date: Mon, 30 Sep 2019 21:36:52 +0300 Subject: [PATCH] Docs adjusted, utils.md added --- docs/bot-usage.md | 10 ++++++++-- docs/utils.md | 26 ++++++++++++++++++++++++++ mkdocs.yml | 9 +++++---- 3 files changed, 39 insertions(+), 6 deletions(-) create mode 100644 docs/utils.md diff --git a/docs/bot-usage.md b/docs/bot-usage.md index f44400e32..795f5f07d 100644 --- a/docs/bot-usage.md +++ b/docs/bot-usage.md @@ -12,17 +12,23 @@ This page explains the different parameters of the bot and how to run it. usage: freqtrade [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH] [--userdir PATH] [-s NAME] [--strategy-path PATH] [--db-url PATH] [--sd-notify] - {backtesting,edge,hyperopt,create-userdir,list-exchanges} ... + {backtesting,edge,hyperopt,create-userdir,list-exchanges,list-timeframes,download-data,plot-dataframe,plot-profit} + ... Free, open source crypto trading bot positional arguments: - {backtesting,edge,hyperopt,create-userdir,list-exchanges} + {backtesting,edge,hyperopt,create-userdir,list-exchanges,list-timeframes,download-data,plot-dataframe,plot-profit} backtesting Backtesting module. edge Edge module. hyperopt Hyperopt module. create-userdir Create user-data directory. list-exchanges Print available exchanges. + list-timeframes Print available ticker intervals (timeframes) for the + exchange. + download-data Download backtesting data. + plot-dataframe Plot candles with indicators. + plot-profit Generate plot showing profits. optional arguments: -h, --help show this help message and exit diff --git a/docs/utils.md b/docs/utils.md new file mode 100644 index 000000000..cfed604bd --- /dev/null +++ b/docs/utils.md @@ -0,0 +1,26 @@ +# Utility Subcommands + +Besides the Live-Trade and Dry-Run run modes, the `backtesting`, `edge` and `hyperopt` optimization subcommands, and the `download-data` subcommand which prepares historical data, the bot contains a number of utility subcommands. They are described in this section. + +## List Exchanges + +``` +usage: freqtrade list-exchanges [-h] [-1] + +optional arguments: + -h, --help show this help message and exit + -1, --one-column Print exchanges in one column. +``` + +## List Timeframes + +``` +usage: freqtrade list-timeframes [-h] [--exchange EXCHANGE] [-1] + +optional arguments: + -h, --help show this help message and exit + --exchange EXCHANGE Exchange name (default: `bittrex`). Only valid if no + config is provided. + -1, --one-column Print exchanges in one column. + +``` diff --git a/mkdocs.yml b/mkdocs.yml index 7aedb4bba..e1b754962 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,14 +14,15 @@ nav: - Data Downloading: data-download.md - Backtesting: backtesting.md - Hyperopt: hyperopt.md - - Edge positioning: edge.md + - Edge Positioning: edge.md + - Utility Subcommands: utils.md - FAQ: faq.md - Data Analysis: data-analysis.md - Plotting: plotting.md - SQL Cheatsheet: sql_cheatsheet.md - - Sandbox testing: sandbox-testing.md - - Deprecated features: deprecated.md - - Contributors guide: developer.md + - Sandbox Testing: sandbox-testing.md + - Deprecated Features: deprecated.md + - Contributors Guide: developer.md theme: name: material logo: 'images/logo.png'