Groups > comp.lang.python > #12055

Thoughts about documentation for non-python resource files

Path	csiph.com!x330-a1.tempe.blueboxinc.net!newsfeed.hal-mli.net!feeder1.hal-mli.net!newsreader4.netcologne.de!news.netcologne.de!xlned.com!feeder7.xlned.com!news2.euro.net!newsgate.cistron.nl!newsgate.news.xs4all.nl!post.news.xs4all.nl!not-for-mail
Return-Path	<tim@johnsons-web.com>
X-Original-To	python-list@python.org
Delivered-To	python-list@mail.python.org
X-Spam-Status	OK 0.001
X-Spam-Evidence	'H': 1.00; 'S': 0.00; 'discussions': 0.03; 'comprises': 0.07; 'mvc': 0.07; 'python': 0.08; 'received:64.4': 0.09; 'subject:files': 0.09; 'subject:python': 0.11; 'protocol': 0.15; 'already.': 0.16; 'non-python': 0.16; 'pythonic': 0.16; 'subject:non': 0.16; "system's": 0.16; 'subject:skip:d 10': 0.17; 'functions,': 0.18; 'topic.': 0.23; 'welcome.': 0.23; 'xml': 0.25; "i'm": 0.27; 'urls': 0.28; 'handled': 0.28; 'html,': 0.29; '(and': 0.29; 'example': 0.30; 'comments.': 0.30; 'css,': 0.30; 'protocols': 0.30; 'thanks': 0.30; 'objects': 0.32; 'there': 0.33; 'to:addr:python-list': 0.33; 'header:User-Agent:1': 0.34; 'views.': 0.34; 'charset:us-ascii': 0.36; 'file': 0.36; 'component': 0.38; 'comments': 0.38; 'to:addr:python.org': 0.39; "i'd": 0.40
Date	Mon, 22 Aug 2011 15:47:04 -0800
From	Tim Johnson <tim@johnsons-web.com>
To	Python ML <python-list@python.org>
Subject	Thoughts about documentation for non-python resource files
MIME-Version	1.0
Content-Type	text/plain; charset=us-ascii
Content-Disposition	inline
Organization	AkWebsoft
User-Agent	Mutt/1.5.20 (2009-06-14)
X-BeenThere	python-list@python.org
X-Mailman-Version	2.1.12
Precedence	list
List-Id	General discussion list for the Python programming language <python-list.python.org>
List-Unsubscribe	<http://mail.python.org/mailman/options/python-list>, <mailto:python-list-request@python.org?subject=unsubscribe>
List-Archive	<http://mail.python.org/pipermail/python-list>
List-Post	<mailto:python-list@python.org>
List-Help	<mailto:python-list-request@python.org?subject=help>
List-Subscribe	<http://mail.python.org/mailman/listinfo/python-list>, <mailto:python-list-request@python.org?subject=subscribe>
Newsgroups	comp.lang.python
Message-ID	<mailman.332.1314057255.27778.python-list@python.org> (permalink)
Lines	26
NNTP-Posting-Host	2001:888:2000:d::a6
X-Trace	1314057255 news.xs4all.nl 23887 [2001:888:2000:d::a6]:58989
X-Complaints-To	abuse@xs4all.nl
Xref	x330-a1.tempe.blueboxinc.net comp.lang.python:12055

Show key headers only | 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