[BioSQL-l] Biopython documentation in BioSQL SVN

[Hilmar Lapp]

On Mar 11, 2008, at 2:51 PM, Peter wrote:

> However, there is some older LaTeX based documentation on our webpage,
> http://biopython.org/DIST/docs/biosql/python_biosql_basic.html
> http://biopython.org/DIST/docs/biosql/python_biosql_basic.pdf
>
> These are currently living in the BioSQL repository,

You mean that the originals are, i.e., the source .tex file, right?  
The files in the BioSQL repository have been updated, and the updates  
should be in the v1.0.0 release.

> [...]
> Does it make sense to have this documentation separate from the
> Biopython code it refers to (which lives in the Biopython repository)?
> For one thing, it complicates access rights for developers.

Indeed. You can have write access but that doesn't mean it would then  
be easy to maintain for you folks (as it being in a non-biopython  
repository likely makes it slip from your mind again).

However, at the end of the day it is your call. I'm happy to leave it  
there, especially if there is continuing interest from Biopython  
folks to keep it updated (if there isn't, I may schedule it for  
deletion for one of the 1.1 or higher releases).

>
> What I would suggest is just to:
>
> (*) add a disclaimer to the top of python_biosql_basic.tex saying this
>     document is depreciated, and giving a link to the wiki page,
>     http://biopython.org/wiki/BioSQL

Just send me a patch of the change you would like to make.

> (*) regenerate the PDF and HTML files.

Those have been regenerated already, before the v1.0.0 release (by  
me, under some pains trying to get HeVeA to do what the original  
creators seemed to have gotten it to do).

> (*) Update these three files in BioSQL's SVN repository.

Done already as far as the change to svn is concerned. Actually, some  
Biopythonist (Sebastian?) walked through the file and made sure  
everything works as described, giving rise to an additional change.

> (*) Copy the new PDF and HTML files over to the Biopython webserver.


Feel free to grab them from svn (or from the BioSQL 1.0.0 release,  
there haven't been any changes since the release).

	-hilmar
-- 
===========================================================
: Hilmar Lapp  -:-  Durham, NC  -:-  hlapp at gmx dot net :
===========================================================