Refactor docs, and add theme

Author: chanfung032

docs/conf.py

@@ -50,7 +50,7 @@
 # The short X.Y version.
 version = '1.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.0testing'
+release = '1.0(rc)'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -99,7 +99,7 @@
 #html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+html_theme_path = ['theme']
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -120,7 +120,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

docs/faq.rst

@@ -176,3 +176,110 @@ https://docs.djangoproject.com/en/1.4/howto/deployment/wsgi/modwsgi/#serving-the
 
 .. _staticfiles_urlpatterns: https://docs.djangoproject.com/en/dev/howto/static-files/#staticfiles-development
 
+如何在SAE上使用Uliweb
+----------------------
+
+Thanks to limodou#gmail.com
+
+uliweb的安装
++++++++++++++
+
+为搭建本地开发环境，你需要安装uliweb 0.0.1a7以上版本或svn中的版本， 简单的安装可以是::
+
+    easy_install Uliweb
+    
+安装后在Python环境下就可以使用uliweb命令行工具了。
+
+目前Uliweb支持Python 2.6和2.7版本。3.X还不支持。
+
+Hello, Uliweb
++++++++++++++++++
+
+让我们从最简单的Hello, Uliweb的开发开始。首先假设你已经有了sae的帐号.
+
+#. 创建一个新的应用，并且选择Python环境。
+#. 从svn环境中checkout一个本地目录
+#. 进入命令行，切換到svn目录下
+#. 创建Uliweb项目::
+
+    uliweb makeproject project
+    
+   会在当前目录下创建一个 ``project`` 的目录。这个目录可以是其它名字，不过它是和后面要使用的 ``index.wsgi`` 对应的，所以建议不要修改。
+    
+#. 创建 ``index.wsgi`` 文件，Uliweb提供了一个命令来做这事::
+
+    uliweb support sae
+    
+   这样会在当前目录下创建一个 ``index.wsgi`` 的文件和 ``lib`` 目录。注意执行时是在svn的目录，即project的父目录中。 
+
+   ``index.wsgi`` 的内容是::
+
+    import sae
+    import sys, os
+    
+    path = os.path.dirname(os.path.abspath(__file__))
+    project_path = os.path.join(path, 'project')
+    sys.path.insert(0, project_path)
+    sys.path.insert(0, os.path.join(path, 'lib'))
+    
+    from uliweb.manage import make_application
+    app = make_application(project_dir=project_path)
+    
+    application = sae.create_wsgi_app(app)
+    
+   其中 ``project`` 和 ``lib`` 都已经加入到 ``sys.path`` 中了。所以建议使用上面
+   的路径，不然就要手工修改这个文件了。
+
+#. 然后就可以按正常的开发app的流程来创建app并写代码了，如::
+
+    cd project
+    uliweb makeapp simple_todo
+    
+    这时一个最简单的Hello, Uliweb已经开发完毕了。
+    
+#. 如果有静态文件，则需要放在版本目录下，Uliweb提供了命令可以提取安装的app的静态文件::
+
+    cd project
+    uliweb exportstatic ../static
+
+#. 如果有第三方源码包同时要上传到sae中怎么办，Uliweb提供了export命令可以导出已经
+   安装的app或指定的模块的源码到指定目录下::
+
+    cd project
+    uliweb export -d ../lib #这样是导出全部安装的app
+    uliweb export -d ../lib module1 module2 #这样是导出指定的模块
+    
+   为什么还需要导出安装的app，因为有些app不是放在uliweb.contrib中的，比如第三方
+   的，所以需要导出后上传。但是因为export有可能导出已经内置于uliweb中的app，所以
+   通常你可能还需要在 ``lib`` 目录下手工删除一些不需要的模块。
+
+#. 提交代码
+   
+   访问 ``http://<你的应用名称>.sinaapp.com`` ，就可看到项目的页面了。
+
+数据库配置
++++++++++++++++++
+
+Uliweb中内置了一个对sae支持的app，还在不断完善中，目前可以方便使用sae提供的MySql
+数据库。
+
+然后修改 ``project/apps/settings.ini`` 在 ``GLOBAL/INSTALLED_APPS`` 最后添加::
+
+    [GLOBAL]
+    INSTALLED_APPS = [
+    ...
+    'uliweb.contrib.sae'
+    ]
+    
+然后为了支持每个请求建立数据库连接的方式，还需要添加一个Middleware在settings.ini中::
+
+    [MIDDLEWARES]
+    transaction = 'uliweb.orm.middle_transaction.TransactionMiddle'
+    db_connection = 'uliweb.contrib.sae.middle_sae_orm.DBConnectionMiddle'
+
+其中第一行是事务支持的Middleware你也可以选择使用。    
+    
+这样就配置好了。而相关的数据库表的创建维护因为sae不能使用命令行，所以要按sae的
+文档说明通过phpMyAdmin来导入。以后Uliweb会増加相应的维护页面来做这事。
+
+