Changeset 347 in main


Ignore:
Timestamp:
09/28/11 10:22:20 (8 years ago)
Author:
pcosquer
Message:

docs, views/main.py: replace all parameters list by an include directive

Location:
trunk
Files:
1 added
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/docs/conf.py

    r232 r347  
    5050# General information about the project. 
    5151project = u'openPLM' 
    52 copyright = u'2010, Pierre Cosquer, Philippe Joulaud' 
     52copyright = u'2010-2011, Pierre Cosquer, Philippe Joulaud' 
    5353 
    5454# The version info for the project you're documenting, acts as replacement for 
     
    5757# 
    5858# The short X.Y version. 
    59 version = '0.1' 
     59version = '0.3' 
    6060# The full version, including alpha/beta/rc tags. 
    61 release = '0.1' 
     61release = '0.3-dev' 
    6262 
    6363# The language for content autogenerated by Sphinx. Refer to documentation 
     
    214214 
    215215autosummary_genererate = ["models.rst", "controllers.rst"] 
     216 
     217rst_epilog = """ 
     218""" 
  • trunk/openPLM/plmapp/forms.py

    r342 r347  
    369369 
    370370class ReplaceManagementForm(forms.Form): 
    371     type = forms.CharField(label=_("Type")) 
     371    type = forms.CharField(label=_("Type"), initial="User") 
    372372    username = forms.CharField(label=_("Username")) 
    373373     
  • trunk/openPLM/plmapp/views/main.py

    r345 r347  
    9898    It computes a context dictionnary based on 
    9999     
    100     :param request: :class:`django.http.QueryDict` 
    101     :param obj_type: :attr:`.PLMObject.type` 
    102     :type obj_type: str 
    103     :param obj_ref: :attr:`.PLMObject.reference` 
    104     :type obj_ref: str 
    105     :param obj_revi: :attr:`.PLMObject.revision` 
    106     :type obj_revi: str 
    107     :return: a :class:`django.http.HttpResponse` 
     100    .. include:: views_params.txt  
    108101    """ 
    109102    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    139132    It computes a context dictionnary based on 
    140133     
    141     :param request: :class:`django.http.QueryDict` 
    142     :param obj_type: :attr:`.PLMObject.type` 
    143     :type obj_type: str 
    144     :param obj_ref: :attr:`.PLMObject.reference` 
    145     :type obj_ref: str 
    146     :param obj_revi: :attr:`.PLMObject.revision` 
    147     :type obj_revi: str 
    148     :return: a :class:`django.http.HttpResponse` 
     134    .. include:: views_params.txt  
    149135    """ 
    150136    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    175161    It computes a context dictionnary based on 
    176162     
    177     :param request: :class:`django.http.QueryDict` 
    178     :param obj_type: :attr:`.PLMObject.type` 
    179     :type obj_type: str 
    180     :param obj_ref: :attr:`.PLMObject.reference` 
    181     :type obj_ref: str 
    182     :param obj_revi: :attr:`.PLMObject.revision` 
    183     :type obj_revi: str 
    184     :return: a :class:`django.http.HttpResponse` 
     163    .. include:: views_params.txt  
    185164    """ 
    186165    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    209188    It computes a context dictionnary based on 
    210189     
    211     :param request: :class:`django.http.QueryDict` 
    212     :param obj_type: :attr:`.PLMObject.type` 
    213     :type obj_type: str 
    214     :param obj_ref: :attr:`.PLMObject.reference` 
    215     :type obj_ref: str 
    216     :param obj_revi: :attr:`.PLMObject.revision` 
    217     :type obj_revi: str 
    218     :return: a :class:`django.http.HttpResponse` 
     190    .. include:: views_params.txt  
    219191    """ 
    220192    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    235207    It computes a context dictionnary based on 
    236208     
    237     :param request: :class:`django.http.QueryDict` 
    238     :param obj_type: :attr:`.PLMObject.type` 
    239     :type obj_type: str 
    240     :param obj_ref: :attr:`.PLMObject.reference` 
    241     :type obj_ref: str 
    242     :param obj_revi: :attr:`.PLMObject.revision` 
    243     :type obj_revi: str 
    244     :return: a :class:`django.http.HttpResponse` 
     209    .. include:: views_params.txt  
    245210    """ 
    246211    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    282247    It computes a context dictionnary based on 
    283248     
    284     :param request: :class:`django.http.QueryDict` 
    285     :param obj_type: :attr:`.PLMObject.type` 
    286     :type obj_type: str 
    287     :param obj_ref: :attr:`.PLMObject.reference` 
    288     :type obj_ref: str 
    289     :param obj_revi: :attr:`.PLMObject.revision` 
    290     :type obj_revi: str 
    291     :return: a :class:`django.http.HttpResponse` 
     249    .. include:: views_params.txt  
    292250    """ 
    293251    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    317275    It computes a context dictionnary based on 
    318276     
    319     :param request: :class:`django.http.QueryDict` 
    320     :param obj_type: :attr:`.PLMObject.type` 
    321     :type obj_type: str 
    322     :param obj_ref: :attr:`.PLMObject.reference` 
    323     :type obj_ref: str 
    324     :param obj_revi: :attr:`.PLMObject.revision` 
    325     :type obj_revi: str 
    326     :return: a :class:`django.http.HttpResponse` 
     277    .. include:: views_params.txt  
    327278    """ 
    328279    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    350301    It computes a context dictionnary based on 
    351302     
    352     :param request: :class:`django.http.QueryDict` 
    353     :param obj_type: :attr:`.PLMObject.type` 
    354     :type obj_type: str 
    355     :param obj_ref: :attr:`.PLMObject.reference` 
    356     :type obj_ref: str 
    357     :param obj_revi: :attr:`.PLMObject.revision` 
    358     :type obj_revi: str 
    359     :return: a :class:`django.http.HttpResponse` 
     303    .. include:: views_params.txt  
    360304    """ 
    361305    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    393337    It computes a context dictionnary based on 
    394338     
    395     :param request: :class:`django.http.QueryDict` 
    396     :param obj_type: :attr:`.PLMObject.type` 
    397     :type obj_type: str 
    398     :param obj_ref: :attr:`.PLMObject.reference` 
    399     :type obj_ref: str 
    400     :param obj_revi: :attr:`.PLMObject.revision` 
    401     :type obj_revi: str 
    402     :return: a :class:`django.http.HttpResponse` 
     339    .. include:: views_params.txt  
    403340    """ 
    404341    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    428365    It computes a context dictionnary based on 
    429366     
    430     :param request: :class:`django.http.QueryDict` 
    431     :param obj_type: :attr:`.PLMObject.type` 
    432     :type obj_type: str 
    433     :param obj_ref: :attr:`.PLMObject.reference` 
    434     :type obj_ref: str 
    435     :param obj_revi: :attr:`.PLMObject.revision` 
    436     :type obj_revi: str 
    437     :return: a :class:`django.http.HttpResponse` 
     367    .. include:: views_params.txt  
    438368    """ 
    439369    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    460390    It computes a context dictionnary based on 
    461391     
    462     :param request: :class:`django.http.QueryDict` 
    463     :param obj_type: :attr:`.PLMObject.type` 
    464     :type obj_type: str 
    465     :param obj_ref: :attr:`.PLMObject.reference` 
    466     :type obj_ref: str 
    467     :param obj_revi: :attr:`.PLMObject.revision` 
    468     :type obj_revi: str 
    469     :return: a :class:`django.http.HttpResponse` 
     392    .. include:: views_params.txt  
    470393    """ 
    471394    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    494417    It computes a context dictionnary based on 
    495418     
    496     :param request: :class:`django.http.QueryDict` 
    497     :param obj_type: :attr:`.PLMObject.type` 
    498     :type obj_type: str 
    499     :param obj_ref: :attr:`.PLMObject.reference` 
    500     :type obj_ref: str 
    501     :param obj_revi: :attr:`.PLMObject.revision` 
    502     :type obj_revi: str 
    503     :return: a :class:`django.http.HttpResponse` 
     419    .. include:: views_params.txt  
    504420    """ 
    505421    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    526442    It computes a context dictionnary based on 
    527443     
    528     :param request: :class:`django.http.QueryDict` 
    529     :param obj_type: :attr:`.PLMObject.type` 
    530     :type obj_type: str 
    531     :param obj_ref: :attr:`.PLMObject.reference` 
    532     :type obj_ref: str 
    533     :param obj_revi: :attr:`.PLMObject.revision` 
    534     :type obj_revi: str 
    535     :return: a :class:`django.http.HttpResponse` 
     444    .. include:: views_params.txt  
    536445    """ 
    537446    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    558467    It computes a context dictionnary based on 
    559468     
    560     :param request: :class:`django.http.QueryDict` 
    561     :param obj_type: :attr:`.PLMObject.type` 
    562     :type obj_type: str 
    563     :param obj_ref: :attr:`.PLMObject.reference` 
    564     :type obj_ref: str 
    565     :param obj_revi: :attr:`.PLMObject.revision` 
    566     :type obj_revi: str 
    567     :return: a :class:`django.http.HttpResponse` 
     469    .. include:: views_params.txt  
    568470    """ 
    569471    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    592494    It computes a context dictionnary based on 
    593495     
    594     :param request: :class:`django.http.QueryDict` 
    595     :param obj_type: :attr:`.PLMObject.type` 
    596     :type obj_type: str 
    597     :param obj_ref: :attr:`.PLMObject.reference` 
    598     :type obj_ref: str 
    599     :param obj_revi: :attr:`.PLMObject.revision` 
    600     :type obj_revi: str 
    601     :return: a :class:`django.http.HttpResponse` 
     496    .. include:: views_params.txt  
    602497    """ 
    603498    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    630525    It computes a context dictionnary based on 
    631526     
    632     :param request: :class:`django.http.QueryDict` 
    633     :param obj_type: :attr:`.PLMObject.type` 
    634     :type obj_type: str 
    635     :param obj_ref: :attr:`.PLMObject.reference` 
    636     :type obj_ref: str 
    637     :param obj_revi: :attr:`.PLMObject.revision` 
    638     :type obj_revi: str 
     527    .. include:: views_params.txt  
    639528    :param link_id: :attr:`.PLMObjectUserLink.id` 
    640529    :type link_id: str 
    641     :return: a :class:`django.http.HttpResponse` 
    642530    """ 
    643531    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    671559    It computes a context dictionnary based on 
    672560     
    673     :param request: :class:`django.http.QueryDict` 
    674     :param obj_type: :attr:`.PLMObject.type` 
    675     :type obj_type: str 
    676     :param obj_ref: :attr:`.PLMObject.reference` 
    677     :type obj_ref: str 
    678     :param obj_revi: :attr:`.PLMObject.revision` 
    679     :type obj_revi: str 
    680     :return: a :class:`django.http.HttpResponse` 
     561    .. include:: views_params.txt  
    681562    """ 
    682563    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    704585    It computes a context dictionnary based on 
    705586     
    706     :param request: :class:`django.http.QueryDict` 
    707     :param obj_type: :attr:`.PLMObject.type` 
    708     :type obj_type: str 
    709     :param obj_ref: :attr:`.PLMObject.reference` 
    710     :type obj_ref: str 
    711     :param obj_revi: :attr:`.PLMObject.revision` 
    712     :type obj_revi: str 
    713     :return: a :class:`django.http.HttpResponse` 
     587    .. include:: views_params.txt  
    714588    """ 
    715589    obj = get_obj(obj_type, obj_ref, obj_revi, request.user) 
     
    820694    It computes a context dictionnary based on 
    821695     
    822     :param request: :class:`django.http.QueryDict` 
    823     :param obj_type: :attr:`.PLMObject.type` 
    824     :type obj_type: str 
    825     :param obj_ref: :attr:`.PLMObject.reference` 
    826     :type obj_ref: str 
    827     :param obj_revi: :attr:`.PLMObject.revision` 
    828     :type obj_revi: str 
    829     :return: a :class:`django.http.HttpResponse` 
     696    .. include:: views_params.txt  
    830697    """ 
    831698    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    856723    :param request: :class:`django.http.QueryDict` 
    857724    :param obj_type: :class:`~django.contrib.auth.models.User` 
    858     :type obj_type: str 
    859     :param obj_ref: :attr:`~django.contrib.auth.models.User.username` 
    860     :type obj_ref: str 
    861     :param obj_revi: "-" 
    862     :type obj_revi: str 
    863725    :return: a :class:`django.http.HttpResponse` 
    864726    """ 
     
    887749     
    888750    :param request: :class:`django.http.QueryDict` 
    889     :param obj_type: :class:`~django.contrib.auth.models.User` 
    890     :type obj_type: str 
    891751    :param obj_ref: :attr:`~django.contrib.auth.models.User.username` 
    892     :type obj_ref: str 
    893     :param obj_revi: "-" 
    894     :type obj_revi: str 
    895752    :return: a :class:`django.http.HttpResponse` 
    896753    """ 
     
    921778    It computes a context dictionnary based on 
    922779     
    923     :param request: :class:`django.http.QueryDict` 
    924     :param obj_type: :class:`~django.contrib.auth.models.User` 
    925     :type obj_type: str 
    926     :param obj_ref: :attr:`~django.contrib.auth.models.User.username` 
    927     :type obj_ref: str 
    928     :param obj_revi: "-" 
    929     :type obj_revi: str 
    930     :return: a :class:`django.http.HttpResponse` 
     780    .. include:: views_params.txt  
    931781    """ 
    932782    obj, ctx, request_dict = get_generic_data(request, obj_type, obj_ref, obj_revi) 
     
    949799     
    950800    :param request: :class:`django.http.QueryDict` 
    951     :param obj_type: :class:`~django.contrib.auth.models.User` 
    952     :type obj_type: str 
    953801    :param obj_ref: :attr:`~django.contrib.auth.models.User.username` 
    954802    :type obj_ref: str 
    955     :param obj_revi: "-" 
    956     :type obj_revi: str 
    957803    :return: a :class:`django.http.HttpResponse` 
    958804    """ 
     
    981827    :param request: :class:`django.http.QueryDict` 
    982828    :param obj_type: :class:`~django.contrib.auth.models.User` 
    983     :type obj_type: str 
    984     :param obj_ref: :attr:`~django.contrib.auth.models.User.username` 
    985829    :type obj_ref: str 
    986     :param obj_revi: "-" 
    987     :type obj_revi: str 
    988830    :param role: :attr:`.DelegationLink.role` if role is not "sign" 
    989831    :type role: str 
     
    1033875     
    1034876    :param request: :class:`django.http.QueryDict` 
    1035     :param obj_type: :class:`~django.contrib.auth.models.User` 
    1036     :type obj_type: str 
    1037877    :param obj_ref: :attr:`~django.contrib.auth.models.User.username` 
    1038878    :type obj_ref: str 
    1039     :param obj_revi: "-" 
    1040     :type obj_revi: str 
    1041879    :param role: :attr:`.DelegationLink.role` if role is not "sign" 
    1042880    :type role: str 
     
    1081919    It computes a context dictionnary based on 
    1082920     
    1083     :param request: :class:`django.http.QueryDict` 
    1084     :param obj_type: :attr:`.PLMObject.type` 
    1085     :type obj_type: str 
    1086     :param obj_ref: :attr:`.PLMObject.reference` 
    1087     :type obj_ref: str 
    1088     :param obj_revi: :attr:`.PLMObject.revision` 
    1089     :type obj_revi: str 
     921    .. include:: views_params.txt  
    1090922    :param file_id_value: :attr:`.DocumentFile.id` 
    1091923    :type file_id_value: str 
     
    1136968    It locks the :class:`DocumentFile` and, after, calls :func:`.views.download` 
    1137969     
    1138     :param request: :class:`django.http.QueryDict` 
    1139     :param obj_type: :attr:`.PLMObject.type` 
    1140     :type obj_type: str 
    1141     :param obj_ref: :attr:`.PLMObject.reference` 
    1142     :type obj_ref: str 
    1143     :param obj_revi: :attr:`.PLMObject.revision` 
    1144     :type obj_revi: str 
     970    .. include:: views_params.txt  
    1145971    :param docfile_id: :attr:`.DocumentFile.id` 
    1146972    :type docfile_id_value: str 
    1147     :return: :func:`.views.download` 
    1148973    """ 
    1149974    obj = get_obj(obj_type, obj_ref, obj_revi, request.user) 
     
    1164989    It computes a context dictionary based on 
    1165990     
    1166     :param request: :class:`django.http.QueryDict` 
    1167     :param obj_type: :class:`~django.contrib.auth.models.User` 
    1168     :type obj_type: str 
    1169     :param obj_ref: :attr:`~django.contrib.auth.models.User.username` 
    1170     :type obj_ref: str 
    1171     :param obj_revi: "-" 
    1172     :type obj_revi: str 
    1173     :return: a :class:`django.http.HttpResponse` 
     991    .. include:: views_params.txt  
    1174992    """ 
    1175993    ctx = get_navigate_data(request, obj_type, obj_ref, obj_revi) 
Note: See TracChangeset for help on using the changeset viewer.