diff options
| author | Ian Cordasco <graffatcolmingov@gmail.com> | 2016-01-25 20:40:33 -0600 |
|---|---|---|
| committer | Ian Cordasco <graffatcolmingov@gmail.com> | 2016-01-25 20:40:33 -0600 |
| commit | f2ca91372aec1a1ca8f13f00df7bd3013b613830 (patch) | |
| tree | 72fe56a73fa3d6e4708a15be7520297f6d17b27f /docs/source | |
| parent | 17a7826dc7e878a0da3fb8b4853ea80c9967ba24 (diff) | |
| download | flake8-f2ca91372aec1a1ca8f13f00df7bd3013b613830.tar.gz | |
Start structuring documentation
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/index.rst | 23 |
1 files changed, 18 insertions, 5 deletions
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` - |