appending new *.texi document to user documentation
Subject: appending new *.texi document to user documentation
From: Jaime Villate
Date: Tue, 12 Jul 2011 11:07:24 +0100
On Mon, 2011-07-11 at 18:36 +0000, Leo Butler wrote:
> Barton Willis <willisb at unk.edu> writes:
>
> > I placed the *.texi user documentation for my Bernstein polynomial code
> > into /doc/info. To fully include this new documentation,
> > what else must I do?
>
> Add your file to the list in Makefile.am.
>
> See item 5 in README.developers-howto in the top directory.
Hi,
I've noticed that section 5.2 in README.developers-howto is outdated
regarding the documentation; it is no longer necessary to build
maxima.texi by hand, as suggested in share/template.texi
A more up-to-date recommendation would be:
-- Move my_package.texi to maxima/doc/info
Put my_package.texi on the list of files in
maxima/doc/info/Makefile.am
Add a line for my_package in the section "Additional packages"
in file maxima/doc/info/include-maxima.texi.in
The line should have the following syntax:
* my_package:: Brief description of my package.
Notice that the additional packages are currently added in
alphabetical order.
I hope this helps and once I start experimenting with git I will update
README.developers-howto and share/template.texi if nobody does it
before.
Cheers,
Jaime