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

Re: Documentation

From: Guillaume Lelarge <guillaume(at)lelarge(dot)info>
To: Dave Page <dpage(at)pgadmin(dot)org>
Cc: pgadmin-hackers <pgadmin-hackers(at)postgresql(dot)org>
Subject: Re: Documentation
Date: 2010-09-26 20:50:19
Message-ID: 4C9FB20B.4040403@lelarge.info (view raw or flat)
Thread:
Lists: pgadmin-hackers
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

In response to

Responses

pgadmin-hackers by date

Next:From: pgAdmin TracDate: 2010-09-26 21:32:49
Subject: [pgAdmin III] #242: Add support for new ALTER TYPE clauses
Previous:From: Guillaume LelargeDate: 2010-09-25 21:21:23
Subject: Re: [pgadmin-support] pgAdmin v1.12.0 Released

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