diff --git a/.travis.yml b/.travis.yml index a452d245b..c75049276 100644 --- a/.travis.yml +++ b/.travis.yml @@ -36,6 +36,11 @@ jobs: name: hyperopt - script: flake8 freqtrade scripts name: flake8 + - script: + # Test Documentation boxes - + # !!! : is not allowed! + - grep -Er '^!{3}\s\S+:' docs/*; test $? -ne 0 + name: doc syntax - script: mypy freqtrade scripts name: mypy 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