Skip site navigation (1) Skip section navigation (2)

Re: Documentation

From: Christophe Chauvet <christophe(at)kryskool(dot)org>
To: Guillaume Lelarge <guillaume(at)lelarge(dot)info>
Cc: Dave Page <dpage(at)pgadmin(dot)org>,pgadmin-hackers <pgadmin-hackers(at)postgresql(dot)org>
Subject: Re: Documentation
Date: 2010-09-27 15:01:38
Message-ID: ba38b725fdda9a033611ebff72cc3b95@localhost (view raw or flat)
Thread:
Lists: pgadmin-hackers
Hi

I wrote a PostgreSQL syntax highlighting [1] for Pygments (used by sphinx for code)

I don't know if it may be useful for the documentation.

Regards,

[1] : https://bitbucket.org/kryskool/pygments-postgresql/

On Sun, 26 Sep 2010 22:50:19 +0200, Guillaume Lelarge <guillaume(at)lelarge(dot)info> wrote:
> Le 24/09/2010 11:16, Guillaume Lelarge a écrit :
>> Le 24/09/2010 10:39, Dave Page a écrit :
>>> On Fri, Sep 24, 2010 at 9:29 AM, Guillaume Lelarge
>>> <guillaume(at)lelarge(dot)info> wrote:
>>>> Documentation for pgAdmin is really weak right now. Just to take an
>>>> example, I don't know where a plugin file is described.
>>>>
>>>> The real question is how we do this. Right now, the documentation is a
>>>> set of HTML files. Which is fine for some people and not for others.
>>>> Kind of hard to get a consistent style. Kind of hard to get a good PDF
>>>> and CHM file out of it. Not sure we really need these formats, I'm
> sure
>>>> we want a consistent style.
>>>>
>>>> The only way to get all these options, AFAICT, is to use Docbook. SGML
>>>> or XML. I have no problem working with Docbook, but I'm not sure
>>>> everyone feels the same. I really prefer XML because of the toolset we
>>>> can use (which seems, at least to me, in much better shape than the
> SGML
>>>> one).
>>>>
>>>> Anyone has better ideas?
>>>
>>> Yeah, I was looking at this the other day, but ran out of time.
>>> Looking at using Sphinx (http://sphinx.pocoo.org/).
>>>
>>
>> Seems interesting. Just at the same time, we (Dalibo) get rid of our
>> documents in ReST format, so I'll still have to work with it for pgadmin
> :-/
>>
>> Anyway, I need to test it a bit before going further on this.
>>
> 
> Seems good to me.
> 
> See
> http://developer.pgadmin.org/~guillaume/pgadmin_docs/_build/html/index.html.
> 
> It took me three hours to manually convert the current documentation.
> There is also a possibility to change the theme. I'll try to do it on my
> laptop.
> 
> 
> --
> Guillaume
>  http://www.postgresql.fr
>  http://dalibo.com
> 
> --
> Sent via pgadmin-hackers mailing list (pgadmin-hackers(at)postgresql(dot)org)
> To make changes to your subscription:
> http://www.postgresql.org/mailpref/pgadmin-hackers


In response to

pgadmin-hackers by date

Next:From: Dave PageDate: 2010-09-27 15:10:43
Subject: 1.12.1?
Previous:From: Thom BrownDate: 2010-09-27 08:42:54
Subject: Re: Documentation

Privacy Policy | About PostgreSQL
Copyright © 1996-2014 The PostgreSQL Global Development Group