Hi there Greg, This is a good idea - and one which is bound to save me lots of questions later on.
I have added an Index to Cookbook.rst, but I cannot commit it back "svn: Authorization failed" . Unsurprising, as I have checked out a "read-only version" from the sf svn code page. Also, can you add a recipe on how to sphinx-generate the documentation (shamefully I have to admit I haven't tested this, bad bad boy). I would like to make hyperlinks from each of the entries in the ToC to the actual code snippets - can I just htmlize the Cookbook documentation with anchors and hrefs ? I think an index section is important, not now, but when you have 20+ entries and you want to check if some bit of functionality is already available or not (stops you from reading the whole page). Here is what it looks like, it comes right after the "What is this" section. Table of Contents ***************** The following recipes are found on this page: * Cleaning up heterocycles - this fixes some [most?] of the annoying "can't kekulize errors" * Parallel conformation generation - this bit of code makes use of your multi-core machine to generate conformers for a particular molecule * Neutralizing Charged Molecules - removes charges from a molecule based on a set of SMARTS patterns NB more details can be found in every mailing-list cited post. p.s. how is the windows 8 build coming along ? :-) - Jean-Paul Ebejer Early Stage Researcher On 27 October 2012 10:59, Greg Landrum <[email protected]> wrote: > > [Another UGM followup] > > Dear all, > > I've started a first pass at creating an RDKit Cookbook. The idea is > to have somewhere to capture small bits of RDKit code that do > something useful but that may not be large enough to be worth doing a > Contrib/ entry. > > I decided to integrate this with the rest of the Sphinx-generated > documentation so that it's easy to find, can be tested, and shows up > in web searches. > > Here's a first pass, with three recipes that have shown up either here > on the mailing list or on the wiki: > http://www.rdkit.org/docs-beta/Cookbook.html > > The source is in SVN: > https://sourceforge.net/p/rdkit/code/2251/tree/trunk/Docs/Book/Cookbook.rst > > It should show up in the github mirror in the near future. > > Feedback and contributions, particularly in the form of either patches > to the docs or standalone pieces of RST I can integrate, are very > welcome. > > Andrew, James, and Hans: the first set of recipes are from posts from > you guys. If you have objections to me using them, please let me know. > > Best, > -greg > > ------------------------------------------------------------------------------ > WINDOWS 8 is here. > Millions of people. Your app in 30 days. > Visit The Windows 8 Center at Sourceforge for all your go to resources. > http://windows8center.sourceforge.net/ > join-generation-app-and-make-money-coding-fast/ > _______________________________________________ > Rdkit-discuss mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/rdkit-discuss ------------------------------------------------------------------------------ The Windows 8 Center - In partnership with Sourceforge Your idea - your app - 30 days. Get started! http://windows8center.sourceforge.net/ what-html-developers-need-to-know-about-coding-windows-8-metro-style-apps/ _______________________________________________ Rdkit-discuss mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/rdkit-discuss
