From 949ca1abf831bdc0f63165f428651fd813d4d16d Mon Sep 17 00:00:00 2001 From: Matthias Date: Thu, 22 Aug 2019 06:53:51 +0200 Subject: [PATCH 1/3] Fail travis if doc-test fails --- .travis.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index a452d245b..308895591 100644 --- a/.travis.yml +++ b/.travis.yml @@ -34,7 +34,11 @@ jobs: - cp config.json.example config.json - freqtrade --datadir freqtrade/tests/testdata hyperopt -e 5 name: hyperopt - - script: flake8 freqtrade scripts + - script: + - flake8 freqtrade scripts + # Test Documentation boxes - + # !!! : is not allowed! + - grep -Er '^!!!\s\S+:' docs/*; test $? -ne 0 name: flake8 - script: mypy freqtrade scripts name: mypy From df1f57392c986963bfda7e835c1119a6cc4367bb Mon Sep 17 00:00:00 2001 From: Matthias Date: Thu, 22 Aug 2019 06:56:41 +0200 Subject: [PATCH 2/3] use seperate job for doc test --- .travis.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 308895591..c75049276 100644 --- a/.travis.yml +++ b/.travis.yml @@ -34,12 +34,13 @@ jobs: - cp config.json.example config.json - freqtrade --datadir freqtrade/tests/testdata hyperopt -e 5 name: hyperopt + - script: flake8 freqtrade scripts + name: flake8 - script: - - flake8 freqtrade scripts # Test Documentation boxes - # !!! : is not allowed! - - grep -Er '^!!!\s\S+:' docs/*; test $? -ne 0 - name: flake8 + - grep -Er '^!{3}\s\S+:' docs/*; test $? -ne 0 + name: doc syntax - script: mypy freqtrade scripts name: mypy From fe12d2e3b705ea1acc8973ee1f3fa21855d914da Mon Sep 17 00:00:00 2001 From: Matthias Date: Thu, 22 Aug 2019 06:57:32 +0200 Subject: [PATCH 3/3] Fix documentation syntax --- docs/bot-usage.md | 3 ++- docs/installation.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/bot-usage.md b/docs/bot-usage.md index 27451bcdb..49b152ae6 100644 --- a/docs/bot-usage.md +++ b/docs/bot-usage.md @@ -2,7 +2,7 @@ This page explains the different parameters of the bot and how to run it. -!!! Note: +!!! Note If you've used `setup.sh`, don't forget to activate your virtual environment (`source .env/bin/activate`) before running freqtrade commands. @@ -141,6 +141,7 @@ Learn more about strategy file in This parameter allows you to add an additional strategy lookup path, which gets checked before the default locations (The passed path must be a directory!): + ```bash freqtrade --strategy AwesomeStrategy --strategy-path /some/directory ``` diff --git a/docs/installation.md b/docs/installation.md index 589d3fe7f..f15cc356c 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -227,7 +227,7 @@ Freqtrade can also be installed using Anaconda (or Miniconda). conda env create -f environment.yml ``` -!!! Note: +!!! Note This requires the [ta-lib](#1-install-ta-lib) C-library to be installed first. ## Windows