And so begins the documentation sprint

pydanny · Jun 3, 2011 · ae08172 · ae08172
1 parent 32baac6
commit ae08172
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -21,3 +21,4 @@ tempfile
 
 # coverage 
 .coverage
+_build
diff --git a/docs/conf.py b/docs/conf.py
@@ -17,20 +17,26 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #sys.path.append(os.path.abspath('../'))
-sys.path.append(os.path.abspath('../'))
-sys.path.append(os.path.abspath('../test_project/'))
+sys.path.insert(0, os.path.abspath('../../'))
+sys.path.insert(0, os.path.abspath('../uni_form/'))
+sys.path.insert(0, os.path.abspath('../test_project'))
+
+import settings
+from django.core.management import setup_environ
+setup_environ(settings)
+
 
 # -- General configuration -----------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix of source filenames.
-source_suffix = '.txt'
+source_suffix = '.rst'
 
 # The encoding of source files.
 #source_encoding = 'utf-8'
@@ -40,7 +46,7 @@
 
 # General information about the project.
 project = u'django-uni-form'
-copyright = u'209-2010, Daniel Greenfeld'
+copyright = u'2009-2011, Daniel Greenfeld'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

diff --git a/docs/customization.txt → docs/customization.rst b/docs/customization.txt → docs/customization.rst
diff --git a/docs/helpers.txt → docs/helpers.rst b/docs/helpers.txt → docs/helpers.rst
diff --git a/docs/index.txt → docs/index.rst b/docs/index.txt → docs/index.rst
@@ -39,6 +39,7 @@ Contents:
    helpers
    customization
    uni_form_tags
+   reference
 
 Indices and tables
 ==================

diff --git a/docs/install.txt → docs/install.rst b/docs/install.txt → docs/install.rst
@@ -12,9 +12,8 @@ Installing django-uni-form
 Install into your python path using pip or easy_install::
 
     pip install django-uni-form
-    easy_install django-uni-form    
     
-Add *'uni_form'* to your INSTALLED_APPS in settings.py::
+Add `uni_form` to your INSTALLED_APPS in settings.py::
 
     INSTALLED_APPS = (
         ...

diff --git a/docs/reference.rst b/docs/reference.rst
@@ -0,0 +1,11 @@
+===================================
+Development reference documentation
+===================================
+
+
+
+
+``helpers`` - form helpers
+==============================
+.. automodule:: helpers
+    :members:
diff --git a/docs/uni_form_tags.txt → docs/uni_form_tags.rst b/docs/uni_form_tags.txt → docs/uni_form_tags.rst
diff --git a/docs/usage.txt → docs/usage.rst b/docs/usage.txt → docs/usage.rst