summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--dev/.keep0
-rw-r--r--docs/source/index.rst23
-rw-r--r--internal/.keep0
-rw-r--r--user/.keep0
4 files changed, 18 insertions, 5 deletions
diff --git a/dev/.keep b/dev/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/dev/.keep
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
--- /dev/null
+++ b/internal/.keep
diff --git a/user/.keep b/user/.keep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/user/.keep