Hi dleach, I've added a "hello world" example project with step-by-step instructions to the repository at https://bitbucket.org/reima/robin. Hope this helps!
- Matthias Am Freitag, 29. Juni 2012 19:49:33 UTC+2 schrieb dleach: > > I'm giving this a try but I'm slightly confused. I'm new to both Doxygen > and Sphinx but I've been able to create content for both. Now I'm trying to > settle on using Sphinx throughout my project and use some tool to bridge > Doxygen content to the Sphinx world. I've tried breathe and then ran across > this tool. > > Does this tool support files section yet? > > It would be useful if the example included a bit more stuff like file > .c/.cpp/.h stuff and some sort of simple "hello world" type of program... > maybe even start with c/cpp code as the example with the doxygen > configuration file so that the users can go end to end on the process (run > doxygen, then run your tools...). > > > > On Friday, June 15, 2012 10:59:01 AM UTC-5, Anteru wrote: >> >> Hi, >> >> We're happy to announce robin, a new Doxygen/C++ to Sphinx bridge. Robin >> provides an easy-to-use, easy-to-hack integration of Doxygen >> documentation into Sphinx. Robin is licensed under the BSD and can be >> found at Bitbucket: https://bitbucket.org/reima/robin >> >> Features >> ======== >> >> * Robust extraction of Doxygen XML data via an easy-to-hack parser >> * Intermediate data is stored in a database (mongodb) for simple >> extraction and processing >> * Directive-driven output; each directive provides callbacks and hooks >> which allows for deep customization >> * Automated generation of driver ReST documents: Similar to automodule; >> however, robin generates actual ReST documents which can be inspected >> >> Prerequisites >> ============= >> >> Robin expects a running mongodb on the local host. It uses a minimal set >> of external libraries: Pymongo, sphinx, progressbar. All of the >> dependencies can be easily installed using pip or easy_install. >> >> Robin has been developed with Python 2.7; we have not tested previous >> versions. >> >> Getting started >> =============== >> >> * Run Doxygen to generate XML documentation (GENERATE_XML=YES) >> * Run extract-doxygen <path to XML> <project name> >> * Run create-rst <project name> >> This generates several directories (classes, groups, etc.) >> Include the groups.rst into your toc >> * Add 'robin.sphinx' to the Sphinx extensions >> * Build (make html) for TOC update >> * Build again (make clean && make html) >> >> Status >> ====== >> >> We're using robin internally for a large C++ codebase, and there are a >> few minor issues left that we hope to resolve soon (all of them are >> tracked on Bitbucket.) After that, we expect that robin will go into >> "maintenance" mode focusing on bug fixes only. If someone is interested >> in contributing, please get in touch with us. >> >> Cheers, >> the robin developers >> > -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To view this discussion on the web visit https://groups.google.com/d/msg/sphinx-dev/-/nsag5_3GiU4J. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
