Update some documentation.

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`.

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

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:
+

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:
+

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
 

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.

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",