[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Denemo-devel] Re: Documentation Cleanup
From: |
Richard Shann |
Subject: |
Re: [Denemo-devel] Re: Documentation Cleanup |
Date: |
Wed, 01 Jul 2009 17:06:17 +0100 |
On Wed, 2009-07-01 at 11:55 -0400, address@hidden wrote:
> > What is restructured text?
> >
> > The only documentation I am maintaining is doc/denemomanual.xml (and I
> > am deriving denemo-manual.html from it via a command hacked out of the
> > makefile, because this is also checked in to git). I edit it (rather
> > painfully) in emacs.
>
> Restructured text is a markup language like docbook except it is
> designed to be human readable/writable in source form. It looks like
> this: [[http://docutils.sourceforge.net/docs/user/rst/quickstart.txt]].
> It can be used generate docbook which can in turn be used to generate
> the manual.
>
>
> > The website contains the up-to-date information on design, roadmap
> > todo etc. Being a wiki it is much easier to maintain than the files
> > in git, so I think those things in git could be reduced to links.
>
> Or removed entirely.
yes
> Maybe documentation in the repository should be
> reduced to a small README file plus the manual?
yes
>
>
> > That would be great - let me know if you are going to do something with
> > doc/denemomanual.xml so that we don't have to merge any work.
>
> Let me come up with a good way to do the conversion, and then I'll ask
> you for your version.
I don't have something not in git, so that's ok at present.
>
>
> By the way, for some reason it's taking almost a week for my emails to
> reach the list. Any idea why?
No, I had that problem when attaching a large patch (before I became an
adminstrator), but I don't know my way around the list management stuff.
I get my emails onto the list very quickly indeed.
Anyone else see this problem????
Richard