[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: API documentation

On Wed, May 23, 2012 at 5:19 AM, Robert James Clay <..hidden..> wrote:
> On Tue, 2012-05-22 at 21:49 -0400, Chris Travers wrote:
>> On Tue, May 22, 2012 at 6:28 PM, Robert James Clay <..hidden..> wrote:
>> >   Haven't checked to see how much space they're taking up (there are
>> > currently some 61 of them) but those are currently included in the
>> > Debian package.  (They're created as part of the build and I then use a
>> > standard Debian helper script to get them installed in the package.)
>> Perfect.  Especially if you have something working for you
>   Besides the man pages and files that are separately installed as
> examples, I also have most of the rest of the documentation installed
> with the current Debian packaging (to /usr/share/doc/ledgersmb).  The
> database sub directory, for instance (though I should perhaps add
> registration of at least the database/ledgersmb.html file, so that it
> also shows up in the documentation menu).  The LedgerSMB Manual, for
> which I have a note about investigating the creation of an HTML version
> of the manual from that same source file.  The templating guide
> (presuming that is it's valid), though I've wondered about providing an
> html version of it with the package rather than the source tex file.
> The faq.html file (is that current?).  The coding-standard.pdf (from
> 2006, and I'm not actually sure why I have that included in the package
> installation...)

Last I read the faq was just before 1.3 was released.  I don't have an
immediate opinion on how up to date it is.  Chances are it needs some
>>  I will put these in a separate tarball.
>   Not sure what you mean.  Separate distribution RPM archive for the
> doc files associated with a particular version?  Separate distribution
> archive for the documentation?

No, what I mean is that since the current make approach puts the
documentation in an out of the way place, I will make them available
in a separate tarball download.  The reasoning is that rpm and deb
packages etc, can install them properly and not have to worry about
also cleaning up whatever I do there.

Just trying not to get in the way of the packagers.

The idea is that way you can keep doing what you are doing, and ignore
what I am doing, and more people know about the documentation.

Best Wishes,
Chris Travers