Hi Ian
On 24 Oct 2002, Ian Bicking wrote:
> Anyway, I've been writing lots of documentation lately, and I've been
> using reStructuredText (http://docutils.sourceforge.net/rst.html). It's
> worked pretty well for me -- the output looks decent, but more
> importantly it's comfortable to write. Ke
Personally I find that I can write the fastest when I write in XML
because I do not have to think at all about the layout.
But the fundamental problem is the content. I would not mind compiling a
list somewhere of what docs we need. I would reccomend that we all work
towards a single book. Co
On Thu, 2002-10-24 at 09:06, Aaron Held wrote:
> >>Anyway, I've been writing lots of documentation lately, and I've been
> >>using reStructuredText (http://docutils.sourceforge.net/rst.html). It's
> >>worked pretty well for me -- the output looks decent, but more
> >>importantly it's comfortable t
I'm willing to try reST or an XML format.
One thing I do like about HTML with styles is that anyone can contribute to
the documentation with just their favorite text editor and a web browser.
Whatever solution we use should be very easy to install and use, and I'd
like to see a "documentation how-
Hi,
I talked a few months back about a book, but it never seemed to get any traction. I'm
big on Xml / Xsl, and am very willing to lend myself to a project like this.
With Python you want the gnome / libxml2 & libxslt python bindings. They are
fantastic.
I also recommend using the Gentoo sty
Hi -
I'm new to this list and while I just barely have scratched the surface
of Webware (and python for that matter), I would be glad to take files
in XML format and generate the HTML documentation using XSLT.
Unfortunately I've had a lot of problems generating output with the
Python XSL proc
I kinda like just using HTML with simple styles for documentation, as we are
now. It works, it's easy to edit by hand, and it's just one less thing to
learn.
You're right, it's the content that's lacking, not the formatting. I don't
really care one way or the other if we split it up or leave it
Looks good. I changed it a bit so it would also monitor modules that
were loaded before ImportSpy was started up (e.g., Application.py). It
would be good to also add any configuration files -- I suppose a hook
could be added to Configurable. To do that ImportSpy should probably
not auto-install
Now that we have auto-restart I'd like to deprecate OneShot.cgi.
There's lots of weird corner-cases and bad behavior that comes about
from OneShot, the performance is really bad, and it just doesn't seem
worth it. Right now auto-reload only works on Posix, but reading the os
docs it looks like it
Earlier this afternoon I committed an auto-reload feature to Webware
CVS. I'd like to credit Tavis Rudd, who provided the initial
implementation for this feature. Here are the details:
Overview
The purpose of this feature is to make life easier on the developer by
having the appserver n
> "ian" == Ian Bicking <[EMAIL PROTECTED]> writes:
ian> The Webware documentation isn't in very good shape, as it hasn't
ian> been actively updated in a while.
Ah, Ian gives me the opening I've been looking for...
I've recently become the managing editor of Py, the Python print journal
(
The Webware documentation isn't in very good shape, as it hasn't been
actively updated in a while.
Anyway, I've been writing lots of documentation lately, and I've been
using reStructuredText (http://docutils.sourceforge.net/rst.html). It's
worked pretty well for me -- the output looks decent, bu
Anyway, I've been writing lots of documentation lately, and I've been
using reStructuredText (http://docutils.sourceforge.net/rst.html). It's
worked pretty well for me -- the output looks decent, but more
importantly it's comfortable to write. Keeping the documentation
up-to-date is the most esse
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Ian Bicking <[EMAIL PROTECTED]> writes:
> I might be able to get over my annoyance with XML if I look deeper
> into Emacs -- I'm sure there's something in there to make it more
> pleasant (maybe abbrev...)
Yes, there's sgml-mode. Supplied with a DTD,
Please comment on this plan:
1) We need content to be written / collected
- I will try to organize something in the next week or so
2) Docstrings will continue to be used in order to describe API's and
classes. (This will be lifted into the appendix section of the Webware
book)
3) Other docs
Ray Leyva wrote:
With Python you want the gnome / libxml2 & libxslt python bindings. They are fantastic.
I also recommend using the Gentoo stylesheets. I've been working with them for a year now, and have found them to be lighter / easier to write to than DocBook.
I also like Gentoo, and I us
I forgot to mention, the documentation tools need to work on Windows. Not
everyone uses Linux to work with Webware.
- Geoff
> -Original Message-
> From: Geoffrey Talvola
> Sent: Thursday, October 24, 2002 12:54 PM
> To: 'Ian Bicking'
> Cc: Webware devel; Webware discuss
> Subject: RE: [
On Thu, 2002-10-24 at 07:18, Stefan Schwarzer wrote:
> > Actually, I guess my real issue is that inline documentation doesn't
> > distinguish between user interfaces and internal interfaces --
> > particularly when those internal interfaces are not entirely internal,
> > like methods that you may w
On Thu, 2002-10-24 at 10:37, Geoffrey Talvola wrote:
> I kinda like just using HTML with simple styles for documentation, as we are
> now. It works, it's easy to edit by hand, and it's just one less thing to
> learn.
Yeah, reST is little weird to learn thoroughly, though the basic
structure is si
19 matches
Mail list logo
