[FIX] sphinx documentation
authorAntony Lesuisse <al@openerp.com>
Tue, 6 Sep 2011 19:17:17 +0000 (21:17 +0200)
committerAntony Lesuisse <al@openerp.com>
Tue, 6 Sep 2011 19:17:17 +0000 (21:17 +0200)
bzr revid: al@openerp.com-20110906191717-pxss44lvysatu07h

Makefile
README.web
doc/source/addons.rst

index 0a4d418..1d4f619 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -3,7 +3,6 @@
 HOST = 127.0.0.1
 PORT = 8080
 
-
 all: run
 
 run:
@@ -25,5 +24,5 @@ clean:
        @rm -rf *.egg-info
 
 cloc:
-       cloc openerpweb/*.py addons/*/controllers/*.py addons/*/static/src/*.js addons/*/static/src/js/*.js addons/*/static/src/css/*.css addons/*/static/src/xml/*.xml
+       cloc addons/*/common/*.py addons/*/controllers/*.py addons/*/static/src/*.js addons/*/static/src/js/*.js addons/*/static/src/css/*.css addons/*/static/src/xml/*.xml
 
index 50cd4fc..eec2d2a 100644 (file)
@@ -1,42 +1,10 @@
-Coding style
-------------
-
-Javascript
-    http://javascript.crockford.com/code.html with the following amendements:
-    - Line Length should be 160 (132?), dont split at 80, rationale in 2011 we all use 16/9 screens
-
-    http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml ?
-
-Modules Conventions
--------------------
-
-addons/<modulename>/controllers/ python controller
-addons/<modulename>/controllers/main.py main python controller is there is only one (or should it be <modulename>.py ?)
-addons/<modulename>/static/ static directory (directly served by the web server)
-addons/<modulename>/static/<external_library>/ directory containing an external javascrip library respect the directory structure of upstream is this directory
-addons/<modulename>/static/openerp/ module specfic static files
-addons/<modulename>/static/openerp/js/ module specific javscript files
-addons/<modulename>/static/openerp/css/ module specific css files
-addons/<modulename>/static/openerp/img/ module specific images files
-addons/<modulename>/static/openerp/ other files
-addons/<modulename>/__openerp__.py module manifest referencing js and css files
-
-
-Dependecies
+OpenERP Web
 -----------
-Depends on
-
-install "CherryPy>=3.1.2" "-d cherrypy"
-install "simplejson>=2.0.9" "-d simplejson"
 
-Maybe soon on
+to build documentation:
 
-#install "Babel>=0.9.4" "-d babel"
-#install "pytz>=2009j" "-d pytz"
+cd doc
+make html
 
-Probably not anymore on:
+then look at doc/build/html/index.html
 
-#install "Mako>=0.2.4" "-d mako"
-#install "formencode>=1.2.2" "-d formencode"
-#install "pyparsing>=1.5.2" "-f pyparsing.py"
-#install "xlwt>=0.7" "-d xlwt"
index 1d577fd..856c8b2 100644 (file)
@@ -338,10 +338,10 @@ replace ``addons`` by the directory in which your own addon lives.
 Python
 ++++++
 
-.. autoclass:: base.common.backendrpc.OpenERPSession
+.. autoclass:: web.common.backendrpc.OpenERPSession
     :members:
 
-.. autoclass:: base.common.backendrpc.OpenERPModel
+.. autoclass:: web.common.backendrpc.OpenERPModel
     :members:
 
 * Addons lifecycle (loading, execution, events, ...)