From b49754dc7d0c813150f9821049b4777a73ad6015 Mon Sep 17 00:00:00 2001 From: Joe Rickerby Date: Sun, 29 Sep 2019 20:28:37 +0100 Subject: [PATCH] mkdocs setup --- docs/mkdocs.yml | 2 ++ docs/pages/index.md | 17 +++++++++++++++++ requirements-dev.txt | 2 ++ 3 files changed, 21 insertions(+) create mode 100644 docs/mkdocs.yml create mode 100644 docs/pages/index.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 00000000..3fe64b17 --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,2 @@ +site_name: My Docs +docs_dir: pages diff --git a/docs/pages/index.md b/docs/pages/index.md new file mode 100644 index 00000000..d3880397 --- /dev/null +++ b/docs/pages/index.md @@ -0,0 +1,17 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](https://mkdocs.org). + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs help` - Print this help message. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. diff --git a/requirements-dev.txt b/requirements-dev.txt index ae60ed5f..c6677778 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,2 +1,4 @@ -e . pytest +mkdocs==1.0.4 +