started using mkdocs

Brendan Whitfield · Brendan Whitfield · commit e00d4af2e6cf · 2015-06-10T20:48:28.000-04:00
diff --git a/docs/Custom Commands.md b/docs/Custom Commands.md
@@ -1,3 +1,6 @@
+Custom OBD Commands
+===================
+
 If the command you need is not in python-OBDs tables, you can create a new `OBDCommand` object. The constructor accepts the following arguments (each will become a property).
 
 | Argument             | Type     | Description                                                              |
diff --git a/docs/OBD Commands.md b/docs/OBD Commands.md
@@ -1,4 +1,8 @@
-An `OBDCommand` in python-OBD is an object used to query information from the vehicle. They contain all of the information neccessary to perform the query, and decode the cars response. Python-OBD has built in tables for the most common commands. They can be looked up by name, or by mode/PID (for a full list, see [Command Tables](https://github.com/brendanwhitfield/python-OBD/wiki/Command-Tables)).
+# OBD Commands
+
+---
+
+An `OBDCommand` is an object used to query information from the vehicle. They contain all of the information neccessary to perform the query, and decode the cars response. Python-OBD has built in tables for the most common commands. They can be looked up by name, or by mode/PID (for a full list, see [Command Tables](https://github.com/brendanwhitfield/python-OBD/wiki/Command-Tables)).
 
 ```python
 import obd
@@ -14,15 +18,17 @@ c = obd.commands['RPM']
 c = obd.commands[1][12] # mode 1, PID 12 (RPM)
 ```
 
-## Methods
+# Methods
+
+---
 
-##### Commands.has_command(command):
+## has_command(command)
 
 Checks the internal command tables for the existance of the given `OBDCommand` object. Commands are compared by mode and PID value.
 
-- - -
+---
 
-##### Commands.has_name(name):
+## has_name(name)
 
 Checks the internal command tables for a command with the given name. This is also the function of the `in` operator.
 
@@ -36,9 +42,9 @@ obd.commands.has_name('RPM') # True
 'RPM' in obd.commands # True
 ```
 
-- - -
+---
 
-##### Commands.has_pid(mode, pid):
+## has_pid(mode, pid)
 
 Checks the internal command tables for a command with the given mode and PID.
 
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](http://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/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,8 @@
+site_name: python-OBD
+repo_url: https://github.com/brendanwhitfield/python-OBD
+repo_name: GitHub
+pages:
+- Home: 'index.md'
+- Commands:
+  - 'OBD Commands': 'OBD Commands.md'
+  - 'Custom Commands': 'Custom Commands.md'
