Changeset 421 in main


Ignore:
Timestamp:
10/28/11 11:51:37 (8 years ago)
Author:
pcosquer
Message:

documentation

Location:
trunk/docs
Files:
1 added
5 edited

Legend:

Unmodified
Added
Removed
  • trunk/docs/architecture.rst

    r420 r421  
    1212Django and Python 
    1313+++++++++++++++++ 
     14 
     15TODO 
    1416 
    1517Celery 
     
    3133South 
    3234+++++ 
     35 
     36`South <http://south.aeracode.org/>`_ is an intelligent schema and data 
     37migrations for Django projects. All applications of OpenPLM are managed by 
     38South to ensure easy updates. 
     39 
    3340 
    3441Haystack and Xapian 
     
    5663====== 
    5764 
     65plmapp is the main application of OpenPLM. It defines main models, views and 
     66controllers and is the core of OpenPLM. 
     67 
    5868Models 
    5969+++++++ 
     70 
     71    A model is the single, definitive source of data about your data. It 
     72    contains the essential fields and behaviors of the data you’re storing. 
     73     
     74    -- `Django's documentation <https://docs.djangoproject.com/en/1.3/topics/db/models/#module-django.db.models>`_ 
     75 
     76Resources: 
     77 
     78    * API: :mod:`~openPLM.plmapp.models` 
     79    * :ref:`Related recipes <cookbook-models>` 
    6080 
    6181Controllers 
    6282+++++++++++ 
    6383 
    64 base 
    65 ---- 
     84In Django, applications do not have dedicate controllers and let this kind of 
     85work to views. But OpenPLM has several kinds of views (html, api), so to 
     86keep the views simple and stupid, OpenPLM has controllers. 
     87Controllers manage user's rights (they ensures the user can do the asked action) 
     88and check inputs. Controllers also keep trace of what have been done 
     89(histories) and send mails to affected users.  
    6690 
    67 plmobject 
    68 --------- 
     91Resources: 
     92     
     93    * :mod:`~plmapp.controllers` 
     94    * base: :mod:`~plmapp.controllers.base` 
     95    * plmobject: :mod:`~plmapp.controllers.plmobject` 
     96    * part: :mod:`~plmapp.controllers.part` 
     97    * document: :mod:`~plmapp.controllers.document` 
     98    * user: :mod:`~plmapp.controllers.user` 
     99    * group: :mod:`~plmapp.controllers.group` 
    69100 
    70 part 
    71 ---- 
    72  
    73 document 
    74 -------- 
    75  
    76 user 
    77 ---- 
    78  
    79 group 
    80 ----- 
    81101 
    82102Forms 
     
    89109----------- 
    90110 
     111Resources: 
     112 
     113    * API: :mod:`~plmapp.base_views` 
     114 
    91115main 
    92116---- 
    93117 
     118Resources: 
     119 
     120    * API: :mod:`~plmapp.views.main` 
     121 
    94122api 
    95123--- 
     124 
     125Resources: 
     126 
     127    * module API: :mod:`~plmapp.views.api` 
     128    * :mod:`the HTTP api <http_api>`. 
     129 
     130ajax 
     131---- 
     132 
     133Resources: 
     134 
     135    * API: :mod:`~plmapp.views.ajax` 
    96136 
    97137Tests 
  • trunk/docs/conf.py

    r420 r421  
    3030settings.configure() 
    3131 
     32from celery import Celery 
     33app = Celery(set_as_current=True) 
     34app.conf.update(BROKER_TRANSPORT="memory", 
     35                CELERY_RESULT_BACKEND="cache", 
     36                CELERY_CACHE_BACKEND="memory", 
     37                CELERYD_HIJACK_ROOT_LOGGER=False, 
     38                CELERYD_LOG_COLOR=False) 
     39 
     40 
    3241# -- General configuration ----------------------------------------------------- 
    3342 
     
    6170# 
    6271# The short X.Y version. 
    63 version = '0.3' 
     72version = '0.4' 
    6473# The full version, including alpha/beta/rc tags. 
    65 release = '0.3-dev' 
     74release = '0.4-dev' 
    6675 
    6776# The language for content autogenerated by Sphinx. Refer to documentation 
  • trunk/docs/controllers.rst

    r336 r421  
    1919    controllers_document 
    2020    controllers_user 
     21    controllers_group 
    2122 
  • trunk/docs/cookbook.rst

    r237 r421  
    55======================================= 
    66 
     7 
     8.. _cookbook-models: 
    79 
    810Models 
     
    3537 
    3638 
     39.. _cookbook-controllers: 
     40 
    3741Controllers 
    3842=============== 
    3943 
    4044 
     45.. _cookbook-tests: 
     46 
    4147Tests 
    4248============== 
     49 
     50.. _cookbook-others: 
    4351 
    4452Others 
  • trunk/docs/index.rst

    r420 r421  
    2222If you are a core developper, you may want to read: 
    2323 
    24     * the :ref:`how-tos <how-tos>` 
     24    * An :doc:`architecture overview </architecture>`  
     25    * Some :ref:`how-tos <how-tos>` 
    2526    * the :ref:`cookbook <cookbook>` which contains some useful pieces of code 
    2627    * :ref:`modules' documentation <modules>` 
Note: See TracChangeset for help on using the changeset viewer.