Hello,
I understand that Pylons is still under continuous development;
however, I felt that this is something that is worth considering for
implementation in the base Pylons template.
I have a question regarding the Pylons default template and a Pylons
application documentation efforts. I am developing a Pylons
application and I plan to design API documentation using Doxygen --
are there better systems to be utilized for this purpose in
documenting Pylons applications? So far I have implemented this for
my configuration and controller files and using doxypy [1] as an
input_filter I am able to use regular Python docstrings to prevent
double-typing comments. I am curious as to what other application
developers use to document their Pylons applications.
I believe it would be useful if when new templates are added, for
example my_template.mako, and compiled, which for this example would
be my_template.mako.by, that base docstrings be included as part of
the file and within the function -- if even as just generic
documentation to be specified by the developer. At least this way
base documentation is generated as part of the template's definition
(unless this is something Pylons does not have control over and is
completely defined by Paste or something else). For example,
my_template.mako.py
-- START CODE --
"""Pylons Template
@author Pylons
@version 1.0.0
Pylons template. Overwrite this with your template documentation."""
...(definitions would go here)...
def render_body(context, **pageargs):
"""Responsible for rendering the body of the template.
@param context purpose of context defined here
@param paraargs contains a dictionary of page arguments for use by
the template.
...(function code would start here)...
-- END CODE --
As a very general question, is there a plan to make more specific
Pylons templates such as one that will include the SQLAlchemy 0.4
support directly within the new template? I understand there might be
sometime before this gets implemented; however, it would be nice to
know what the status on such integration is.
I hope I have made this clear, if not please let me know so I can
clarify. Thanks.
[1] http://code.foosel.org/doxypy -- last updated December 2, 2007 :)
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"pylons-discuss" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/pylons-discuss?hl=en
-~----------~----~----~----~------~----~------~--~---
