Merge pull request #1447 from mishaker/docs

Readthedocs configuration
This commit is contained in:
Matthias 2018-12-28 19:46:33 +01:00 committed by GitHub
commit 884e1bd9a9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 32 additions and 12 deletions

8
.readthedocs.yml Normal file
View File

@ -0,0 +1,8 @@
# .readthedocs.yml
build:
image: latest
python:
version: 3.6
setup_py_install: false

BIN
docs/images/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

View File

@ -1,4 +1,4 @@
# freqtrade documentation # Introduction
Welcome to freqtrade documentation. Please feel free to contribute to Welcome to freqtrade documentation. Please feel free to contribute to
this documentation if you see it became outdated by sending us a this documentation if you see it became outdated by sending us a

View File

@ -3,7 +3,6 @@ Before running your bot in production you will need to setup few
external API. In production mode, the bot required valid Bittrex API external API. In production mode, the bot required valid Bittrex API
credentials and a Telegram bot (optional but recommended). credentials and a Telegram bot (optional but recommended).
## Table of Contents
- [Setup your Bittrex account](#setup-your-bittrex-account) - [Setup your Bittrex account](#setup-your-bittrex-account)
- [Backtesting commands](#setup-your-telegram-bot) - [Backtesting commands](#setup-your-telegram-bot)
@ -45,4 +44,3 @@ For a description of the Bot API, see this page: https://core.telegram.org/bots/
**2.1. Talk to https://telegram.me/userinfobot** **2.1. Talk to https://telegram.me/userinfobot**
**2.2. Get your "Id", you will use it for the config parameter **2.2. Get your "Id", you will use it for the config parameter
`chat_id`.** `chat_id`.**

View File

@ -0,0 +1 @@
mkdocs-material==3.1.0

13
mkdocs.yml Normal file
View File

@ -0,0 +1,13 @@
site_name: Freqtrade
theme:
name: material
logo: 'images/logo.png'
palette:
primary: 'blue grey'
accent: 'tear'
markdown_extensions:
- admonition
- codehilite:
guess_lang: false
- toc:
permalink: false