Re: question on doc
On Wed, Dec 14, 2011 at 05:46:30PM +0100, Olivier Sallou wrote:
> With clustal omega, there is HTML documentation for the API ( for
> libclustalo-dev).
>
> Should I create a sub package for API documentation, as it is a little
> big and keep it arch independant (and in this case, which section should
> I set for the package) ?
You should definitely split the doc if lintian will inform you about
large arch=all chunks (also check lintian -I!). Otherwise it might be
a matter of taste. I'm personally a friend of splitting things.
> Should I gzip the HTML files ? Debian policy suggests to do so, but in
> case of HTML, it is not a single file but a bunch of files....
> And, if gzipped, what should I put in xx.doc-base (it is not really HTML
> anymore....)
Hmmm, I think html files are not gzipped - at least in all my packages
HTML will not be zipped. However, I did not checked recend docs about
this.
> At least, I have some errors with lintian on doc-base. Though I follow
> tutorial at [1]:
>
> E: libclustalo-dev: doc-base-file-unknown-field libclustalo-dev:6 format
> E: libclustalo-dev: doc-base-file-unknown-field libclustalo-dev:7 index
> E: libclustalo-dev: doc-base-file-unknown-field libclustalo-dev:8 files
>
> For the file:
> Document: libclustalo-dev
> Title: Clustal Omega API
> Author: Generated from Doxygen
> Abstract: API for development with clustal omega
> Section: Programming/C++
<<--- if I'm not totally wrong you need an empty line here.
> Format: HTML
> Index: /usr/share/doc/libclustalo-dev/api/html/index.html
> Files: /usr/share/doc/libclustalo-dev/api/html/*
Kind regards
Andreas.
--
http://fam-tille.de
Reply to: