Groups > comp.lang.python > #12055

Thoughts about documentation for non-python resource files

Date	2011-08-22 15:47 -0800
From	Tim Johnson <tim@johnsons-web.com>
Subject	Thoughts about documentation for non-python resource files
Organization	AkWebsoft
Newsgroups	comp.lang.python
Message-ID	<mailman.332.1314057255.27778.python-list@python.org> (permalink)

Show all headers | View raw

I'm looking for comments and/or URLs to discussions on this topic.

I use my own MVC system. A component of this system generates
documentation from python docstrings. Of course this system also
comprises many non-python filetypes : css, html, txt, js, xml etc.
Views, which are txt or html files can be handled by my system's
built-in relationships between controllers and views.

For other non-python files which are not found directly to
controllers, css, js, html, xml all support comments and
documentation can be (and is) build into the comments.

Before I proceded and 'roll my own' protocol for generating
documentations for these above-mention filetypes, I'd like to know
if there is any such protocols being used already.

Example : A pythonic way to generate documentations on a javascript
file as well as its functions, objects etc.

Any comments welcome.

thanks
-- 
Tim 
tim at johnsons-web dot com or akwebsoft dot com
http://www.akwebsoft.com

Back to comp.lang.python | Previous | Next | Find similar | Unroll thread

Thread

Thoughts about documentation for non-python resource files Tim Johnson <tim@johnsons-web.com> - 2011-08-22 15:47 -0800

csiph-web