On Wed, Jun 9, 2010 at 3:33 PM, Noel O'Boyle <[email protected]> wrote: > On 8 June 2010 22:18, Noel O'Boyle <[email protected]> wrote: >> On 8 June 2010 17:59, Tim Vandermeersch <[email protected]> wrote: >>> Hi, >>> >>> Andrew has raised some important issues with outdated docs etc. I >>> think we should turn all wiki pages into in-source documentation >>> (using doxygen for example) that is updated nightly. The current wiki >>> is just not suited for maintainability IMHO, there is no real overview >>> of files. We can't grep through it. It can also be a set of test >>> files, as long as it is easier to maintain. Do we really benefit from >>> the wiki? I mean: Are there users contributing to the wiki who >>> wouldn't if we moved it to svn/git. >> >> I don't think we should replace the wiki with doxygen, but we could >> replace it with sphinx. We could then use "breathe" to bridge from >> that to the existing API docs, which I guess we will still keep in >> doxygen format. We are planning (or at least I was :-) ) to move to >> Sphinx anyway with molcore, so we can just bring it forward a bit. >> >> I'll work on a proof of concept if this sounds like a plan. > > The doxygen docs look much better than "breathe". Moving the wiki docs > to Sphinx at least will enforce a hierarchy, our main problem with the > current docs as I see it. There seem to be Mediawiki to RST converts > available so I'll see how that goes...maybe tomorrow....
Did you know you can use github for hosting html pages? This would make it very easy to update, you just push to github. See http://pages.github.com/ for more info. > >>> I've but serious effort in documenting my changes to the >>> stereochemistry but this can only be seen by generating the developer >>> docs. >> >> I know - it looks really good. Now that we have a nightly build, we >> should set up automatic generation of the docs and make them available >> from http://openbabel.org/dev-api. Assuming that we are still using >> SourceForge for this, I can scp the docs there automatically. >> >> - Noel >> >> >>> Tim >>> >>> ------------------------------------------------------------------------------ >>> ThinkGeek and WIRED's GeekDad team up for the Ultimate >>> GeekDad Father's Day Giveaway. ONE MASSIVE PRIZE to the >>> lucky parental unit. See the prize list and enter to win: >>> http://p.sf.net/sfu/thinkgeek-promo >>> _______________________________________________ >>> OpenBabel-Devel mailing list >>> [email protected] >>> https://lists.sourceforge.net/lists/listinfo/openbabel-devel >>> >> > ------------------------------------------------------------------------------ ThinkGeek and WIRED's GeekDad team up for the Ultimate GeekDad Father's Day Giveaway. ONE MASSIVE PRIZE to the lucky parental unit. See the prize list and enter to win: http://p.sf.net/sfu/thinkgeek-promo _______________________________________________ OpenBabel-Devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/openbabel-devel
