Tomas Toft <[EMAIL PROTECTED]> writes: > Hi all > > Martin Geisler wrote: >> Martin Geisler <[EMAIL PROTECTED]> writes: >> >>> I'll try and make a third builder now which runs Epydoc whenever >>> the source changes and maybe even uploads the API docs to viff.dk. >> >> This now works -- the documentation is now automatically built and >> uploaded to viff.dk on every change. Try it out: improve one of the >> docstrings, commit it and let me know! >> >> We should probably indicate somewhere that the API docs reflects >> the code in Mercurial and not the latest release. Or maybe it would >> be better if we put both online? What do you guys think? > > I would go for both (or rather: /all/ releases + current) and > clearly mark what is what. For project developers, the current is > best as it lets everyone know what the state of everything is at the > present. But most "standard" developers will pick a release version > and stick to it rather than use the current, and leaving actual > users without an online api sounds really bad. :-)
Yeah, I think it sounds a bit strange too. So we could make a simple system below api/ like this: api/0.1/ <- fixed location for old API docs api/0.2/ api/0.3/ api/devel/ <- automatically generated when repository changes. Should we include a directory with a fixed name which is just a symlink to the latest release? Also, if you go to api/ then you should be greeted with a page that explains you your options. -- Martin Geisler _______________________________________________ viff-devel mailing list (http://viff.dk/) [email protected] http://lists.viff.dk/listinfo.cgi/viff-devel-viff.dk
