From f2ca91372aec1a1ca8f13f00df7bd3013b613830 Mon Sep 17 00:00:00 2001 From: Ian Cordasco Date: Mon, 25 Jan 2016 20:40:33 -0600 Subject: [PATCH] Start structuring documentation --- dev/.keep | 0 docs/source/index.rst | 23 ++++++++++++++++++----- internal/.keep | 0 user/.keep | 0 4 files changed, 18 insertions(+), 5 deletions(-) create mode 100644 dev/.keep create mode 100644 internal/.keep create mode 100644 user/.keep diff --git a/dev/.keep b/dev/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/source/index.rst b/docs/source/index.rst index 904ca87..3557d34 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,14 +3,28 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to flake8's documentation! -================================== +Flake8: Your Tool For Style Guide Enforcement +============================================= -Contents: +User Guide +---------- .. toctree:: - :maxdepth: 2 + :maxdepth: 2 +Plugin Developer Guide +---------------------- + +.. toctree:: + :maxdepth: 2 + + internal/option_handling.rst + +Developer Guide +--------------- + +.. toctree:: + :maxdepth: 2 Indices and tables @@ -19,4 +33,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` - diff --git a/internal/.keep b/internal/.keep new file mode 100644 index 0000000..e69de29 diff --git a/user/.keep b/user/.keep new file mode 100644 index 0000000..e69de29