From 3416663637a5a6a6045ed22b4360a0b986bf4511 Mon Sep 17 00:00:00 2001 From: Antony Lesuisse Date: Tue, 6 Sep 2011 21:17:17 +0200 Subject: [PATCH] [FIX] sphinx documentation bzr revid: al@openerp.com-20110906191717-pxss44lvysatu07h --- Makefile | 3 +-- README.web | 42 +++++------------------------------------- doc/source/addons.rst | 4 ++-- 3 files changed, 8 insertions(+), 41 deletions(-) diff --git a/Makefile b/Makefile index 0a4d41800e0..1d4f6194a88 100644 --- 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 diff --git a/README.web b/README.web index 50cd4fcaaf6..eec2d2a1896 100644 --- a/README.web +++ b/README.web @@ -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//controllers/ python controller -addons//controllers/main.py main python controller is there is only one (or should it be .py ?) -addons//static/ static directory (directly served by the web server) -addons//static// directory containing an external javascrip library respect the directory structure of upstream is this directory -addons//static/openerp/ module specfic static files -addons//static/openerp/js/ module specific javscript files -addons//static/openerp/css/ module specific css files -addons//static/openerp/img/ module specific images files -addons//static/openerp/ other files -addons//__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" +to build documentation: -Maybe soon on +cd doc +make html -#install "Babel>=0.9.4" "-d babel" -#install "pytz>=2009j" "-d pytz" +then look at doc/build/html/index.html -Probably not anymore on: - -#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" diff --git a/doc/source/addons.rst b/doc/source/addons.rst index 1d577fd52de..856c8b2a6c3 100644 --- a/doc/source/addons.rst +++ b/doc/source/addons.rst @@ -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, ...)