Docs adjusted, utils.md added

This commit is contained in:
hroff-1902 2019-09-30 21:36:52 +03:00
parent e9d9df3473
commit cd0e813a85
3 changed files with 39 additions and 6 deletions

View File

@ -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] usage: freqtrade [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH]
[--userdir PATH] [-s NAME] [--strategy-path PATH] [--userdir PATH] [-s NAME] [--strategy-path PATH]
[--db-url PATH] [--sd-notify] [--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 Free, open source crypto trading bot
positional arguments: 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. backtesting Backtesting module.
edge Edge module. edge Edge module.
hyperopt Hyperopt module. hyperopt Hyperopt module.
create-userdir Create user-data directory. create-userdir Create user-data directory.
list-exchanges Print available exchanges. 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: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit

26
docs/utils.md Normal file
View File

@ -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.
```

View File

@ -14,14 +14,15 @@ nav:
- Data Downloading: data-download.md - Data Downloading: data-download.md
- Backtesting: backtesting.md - Backtesting: backtesting.md
- Hyperopt: hyperopt.md - Hyperopt: hyperopt.md
- Edge positioning: edge.md - Edge Positioning: edge.md
- Utility Subcommands: utils.md
- FAQ: faq.md - FAQ: faq.md
- Data Analysis: data-analysis.md - Data Analysis: data-analysis.md
- Plotting: plotting.md - Plotting: plotting.md
- SQL Cheatsheet: sql_cheatsheet.md - SQL Cheatsheet: sql_cheatsheet.md
- Sandbox testing: sandbox-testing.md - Sandbox Testing: sandbox-testing.md
- Deprecated features: deprecated.md - Deprecated Features: deprecated.md
- Contributors guide: developer.md - Contributors Guide: developer.md
theme: theme:
name: material name: material
logo: 'images/logo.png' logo: 'images/logo.png'