builVersion run sphinx.

.gitignore

@@ -15,8 +15,8 @@ static/plugin_ace/
 static/plugin_dbui/dbui-debug.js
 static/plugin_dbui/dbui-min.js
 static/plugin_extjs/
-static/plugin_dbui/docs/epydoc
 static/plugin_dbui/docs/jsduck
+static/plugin_dbui/docs/sphinx
 static/plugin_mathjax/
 uploads/
 web2py.plugin.dbui.*.w2p

buildVersion.py

@@ -51,8 +51,8 @@ JSDOC = 'static/plugin_dbui/docs/jsduck'
 JSLIBDEBUG = 'static/plugin_dbui/dbui-debug.js'
 JSLIBMIN = 'static/plugin_dbui/dbui-min.js'
 JSLIBSRC = 'static/plugin_dbui/src'
-SPHINXDOC = 'static/docs/sphinx'
-SPHINXSRC = 'docs/api/'
+SPHINXDOC = 'static/plugin_dbui/docs/sphinx'
+SPHINXSRC = 'docs/api'
 
 NOW = datetime.datetime.now()
 PACK_PLUGIN_URL = 'http://localhost:8000/%s/default/pack_plugin' % APP
@@ -248,6 +248,30 @@ def set_version(version):
         os.remove(fn)
 
 
+def sphinx():
+    """Generate the Sphinx documentation.
+
+    """
+    if not os.path.exists(SPHINX):
+        print '\n\tThe application sphinx is missing !'
+        print '\tSkip this step.\n'
+        return
+
+    if not os.path.exists(SPHINXSRC):
+        print '\nNo sphinx source file !'
+        return
+
+    # clean the directory
+    cmd = ["rm", "-rf", SPHINXDOC]
+    subprocess.call(cmd)
+
+    # generate the HTML version
+    cmd = [SPHINX, "-b", "html", SPHINXSRC, SPHINXDOC]
+    subprocess.call(cmd)
+
+    print "\nSphinx HTML documentation in", SPHINXDOC, "\n"
+
+
 def web2py():
     """Produce the binary file for the web2py plugin.
 
@@ -306,7 +330,12 @@ if __name__ == '__main__':
                    dest="get",
                    help="get the version of the current release and exit.")
 
-    ops.add_option("-s", "--set_version",
+    ops.add_option("-s", "--sphinx",
+                   action="store_true",
+                   dest="sphinx",
+                   help="generate sphinx documentation.")
+
+    ops.add_option("-v", "--set_version",
                    action="store_true",
                    dest="set",
                    help="set the version.")
@@ -322,6 +351,7 @@ if __name__ == '__main__':
                      git=False,
                      jsduck=False,
                      set=False,
+                     sphinx=False,
                      web2py=False)
 
     (opt, args) = ops.parse_args()
@@ -346,6 +376,9 @@ if __name__ == '__main__':
     if opt.compile:
         compile()
 
+    if opt.sphinx:
+        sphinx()
+
     if opt.web2py:
         jsduck()
         compile()
@@ -362,6 +395,7 @@ if __name__ == '__main__':
 
         git()
         jsduck()
+        sphinx()
         compile()
         web2py()
 

docs/api/conf.py

@@ -39,7 +39,7 @@ extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.viewcode']
 
 # autosummary configuration
-autosummary_generate = True
+autosummary_generate = False
 
 # intersphinx configuration
 intersphinx_mapping = {'python': ('http://docs.python.org/2.7', None)}