From 392a8ff457450d3e969b56dc0ae9773089e0087d Mon Sep 17 00:00:00 2001 From: knmcguire <kimberly@bitcraze.io> Date: Wed, 7 Aug 2019 16:25:39 +0200 Subject: [PATCH] #124 adding infrastructure to start documentation --- .gitignore | 8 ++++++++ docs/_data/menu.yml | 8 ++++++++ docs/index.md | 10 ++++++++++ 3 files changed, 26 insertions(+) create mode 100644 docs/_data/menu.yml create mode 100644 docs/index.md diff --git a/.gitignore b/.gitignore index c6195bd..77c4211 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,11 @@ dist/* .tox* venv* **/cache/*.json + +#eclipse generated files +.project +.pydevproject +.settings/* + +#jekyll generated pages +docs/.jekyll-metadata diff --git a/docs/_data/menu.yml b/docs/_data/menu.yml new file mode 100644 index 0000000..7484c35 --- /dev/null +++ b/docs/_data/menu.yml @@ -0,0 +1,8 @@ +- page_id: home +- title: Install Instructions + subs: + - {page_id: dummy} + + + + diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e7a5eb4 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,10 @@ +--- +title: Home +page_id: home +--- + +cflib is an API written in Python that is used to communicate with the Crazyflie +and Crazyflie 2.0 quadcopters. It is intended to be used by client software to +communicate with and control a Crazyflie quadcopter. For instance the [Crazyflie PC client](https://github.com/bitcraze/crazyflie-clients-python) uses the cflib. + + -- GitLab