Re: [HACKERS] Extensions Documentation

2012-11-02 Thread David E. Wheeler
On Nov 2, 2012, at 7:56 AM, Dimitri Fontaine wrote: >> I'd also be in favor of adding hooks to generate man pages. > > Who still use their local copy of the docs (without search ability) > anyway? About man pages, I don't know how many DBA are looking there > when they want to find some document

Re: [HACKERS] Extensions Documentation

2012-11-02 Thread Dimitri Fontaine
"David E. Wheeler" writes: > Put it into the HTML directory > (share/docs/html/extensions/$extension.html) and inject its name into > the TOC. > > I'd also be in favor of adding hooks to generate man pages. Who still use their local copy of the docs (without search ability) anyway? About man page

Re: [HACKERS] Extensions Documentation

2012-10-30 Thread David E. Wheeler
On Oct 30, 2012, at 2:08 PM, Peter Eisentraut wrote: >> True, which is why I was thinking of something relatively light-weight >> and self-contained like sundown. > > That's a markdown library, which transforms markdown to HTML, right? So > what would we do with the HTML? Put it into the HTML

Re: [HACKERS] Extensions Documentation

2012-10-30 Thread Peter Eisentraut
On Fri, 2012-10-26 at 09:09 -0700, David E. Wheeler wrote: > On Oct 26, 2012, at 5:27 AM, Peter Eisentraut wrote: > > The advantage that these programming language ecosystems have is that > > they can implement the processors for the documentation format in the > > language itself, so it's easy t

Re: [HACKERS] Extensions Documentation

2012-10-26 Thread David E. Wheeler
On Oct 26, 2012, at 5:27 AM, Peter Eisentraut wrote: > > The advantage that these programming language ecosystems have is that > they can implement the processors for the documentation format in the > language itself, so it's easy to recommend or enforce a particular > system. I don't think we'

Re: [HACKERS] Extensions Documentation

2012-10-26 Thread Peter Eisentraut
On 10/25/12 1:53 PM, David E. Wheeler wrote: > I'm thinking of Pod as the precedent here, but I think most of the popular > programming language ecosystems offer something like this (JavaDoc, rdoc, > etc.). The advantage that these programming language ecosystems have is that they can implement

Re: [HACKERS] Extensions Documentation

2012-10-25 Thread David E. Wheeler
On Oct 25, 2012, at 5:07 PM, Peter Eisentraut wrote: > I think the emerging standard is to have a README.md (or something > similar). This gives enough structure and formatting options for most > extensions. For PGXN, I have used a README.md for a readme (briefly about the extension, how to bu

Re: [HACKERS] Extensions Documentation

2012-10-25 Thread Peter Eisentraut
On Thu, 2012-10-25 at 10:31 -0700, David E. Wheeler wrote: > Any plans to implement a documentation standard for extensions? I would love > to see `make install` create the necessary man pages and perhaps even HTML > (with a link added in the proper place). Anyone given this any thought? Dim? I

Re: [HACKERS] Extensions Documentation

2012-10-25 Thread David E. Wheeler
On Oct 25, 2012, at 10:42 AM, Simon Riggs wrote: >> Any plans to implement a documentation standard for extensions? I would love >> to see `make install` create the necessary man pages and perhaps even HTML >> (with a link added in the proper place). Anyone given this any thought? Dim? > > Isn

Re: [HACKERS] Extensions Documentation

2012-10-25 Thread Simon Riggs
On 25 October 2012 19:31, David E. Wheeler wrote: > Hackers, > > Any plans to implement a documentation standard for extensions? I would love > to see `make install` create the necessary man pages and perhaps even HTML > (with a link added in the proper place). Anyone given this any thought? Dim