Hi, Someone on StackOverflow (http://stackoverflow.com/questions/4774415/ documenting-custom-programming-language-api) recommended Sphinx to me as a documentation tool for my project.
My project (http://code.google.com/p/geogen/) is written in C++ and features a specialized scripting API with several classes, cca. 120 methods and some constants and enumerations. I really like the documentations created with Sphinx, but I have a few issues with it I would like to resolve before I invest the time to transition from Doxygen documentation to Sphinx. 1) Images in documentation - I want to have images embedded at various places in the documentation - for example since my project is graphics related, I want to have examples of how individual methods affect the worked bitmap. 2) Enumerations - While browsing through the Sphinx documentation, I didn't see any mention of enumerations. How can I document these with sphinx? I have quite a few of them in my project. 3) Documentation of individual methods parameters - Some of the methods I want to document have about 8 parameters. Documenting these with a paragraph or two is not practical - I want to have each method documented with a short paragraph of text and a list of parameters, each with its own very short description. Thanks for any advice -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
