From 4dfd2974723a349b82b9837813b42a87d28d7267 Mon Sep 17 00:00:00 2001
From: Ben Kurtovic <ben.kurtovic@gmail.com>
Date: Mon, 5 May 2014 10:35:57 -0400
Subject: [PATCH] Update some documentation.

---
 README.md                             |  6 ++++++
 bitshift/__init__.py                  |  9 ++++++++-
 docs/source/api/bitshift.crawler.rst  | 27 +++++++++++++++++++++++++++
 docs/source/api/bitshift.database.rst | 19 +++++++++++++++++++
 docs/source/api/bitshift.rst          | 10 ++--------
 docs/source/conf.py                   |  2 +-
 setup.py                              |  2 +-
 7 files changed, 64 insertions(+), 11 deletions(-)
 create mode 100644 docs/source/api/bitshift.crawler.rst
 create mode 100644 docs/source/api/bitshift.database.rst

diff --git a/README.md b/README.md
index 8ca31d7..96a93bc 100644
--- a/README.md
+++ b/README.md
@@ -32,3 +32,9 @@ root. Note that this will revert any custom changes made to the files in
 `docs/source/api`, so you might want to update them by hand instead.
 
 [SASS]: http://sass-lang.com/guide
+
+Releasing
+---------
+
+- Update `__version__` in `bitshift/__init__.py`, `version` in `setup.py`, and
+  `version` and `release` in `docs/conf.py`.
diff --git a/bitshift/__init__.py b/bitshift/__init__.py
index 78ca5e9..0bd031c 100644
--- a/bitshift/__init__.py
+++ b/bitshift/__init__.py
@@ -1 +1,8 @@
-from . import assets, codelet, config, database, parser, query, crawler
+# -*- coding: utf-8  -*-
+
+__author__ = "Benjamin Attal, Ben Kurtovic, Severyn Kozak"
+__copyright__ = "Copyright (c) 2014 Benjamin Attal, Ben Kurtovic, Severyn Kozak"
+__license__ = "MIT License"
+__version__ = "0.1.dev"
+
+from . import assets, codelet, config, crawler, database, parser, query
diff --git a/docs/source/api/bitshift.crawler.rst b/docs/source/api/bitshift.crawler.rst
new file mode 100644
index 0000000..2add004
--- /dev/null
+++ b/docs/source/api/bitshift.crawler.rst
@@ -0,0 +1,27 @@
+crawler Package
+===============
+
+:mod:`crawler` Package
+----------------------
+
+.. automodule:: bitshift.crawler
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`crawler` Module
+---------------------
+
+.. automodule:: bitshift.crawler.crawler
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`indexer` Module
+---------------------
+
+.. automodule:: bitshift.crawler.indexer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/source/api/bitshift.database.rst b/docs/source/api/bitshift.database.rst
new file mode 100644
index 0000000..38e20b6
--- /dev/null
+++ b/docs/source/api/bitshift.database.rst
@@ -0,0 +1,19 @@
+database Package
+================
+
+:mod:`database` Package
+-----------------------
+
+.. automodule:: bitshift.database
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`migration` Module
+-----------------------
+
+.. automodule:: bitshift.database.migration
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/docs/source/api/bitshift.rst b/docs/source/api/bitshift.rst
index 1b1c703..388ac71 100644
--- a/docs/source/api/bitshift.rst
+++ b/docs/source/api/bitshift.rst
@@ -33,19 +33,13 @@ bitshift Package
     :undoc-members:
     :show-inheritance:
 
-:mod:`database` Module
-----------------------
-
-.. automodule:: bitshift.database
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 Subpackages
 -----------
 
 .. toctree::
 
+    bitshift.crawler
+    bitshift.database
     bitshift.parser
     bitshift.query
 
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 5aee357..1f9d1be 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -59,7 +59,7 @@ copyright = u'2014, Benjamin Attal, Ben Kurtovic, Severyn Kozak'
 # The short X.Y version.
 version = '0.1'
 # The full version, including alpha/beta/rc tags.
-release = '0.1'
+release = '0.1.dev'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/setup.py b/setup.py
index 47508e9..48d4c42 100644
--- a/setup.py
+++ b/setup.py
@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name = "bitshift",
-    version = "0.1",
+    version = "0.1.dev",
     packages = find_packages(),
     install_requires = [
         "Flask>=0.10.1", "pygments>=1.6", "requests>=2.2.0",