I just pushed https://code.launchpad.net/~daniel-nichter/drizzle/plugin-docs. I'm working on documenting all of Drizzle's plugins. I wrote a program that auto-generated .rst skeletons for each plugin by parsing the .cc files, and now I'm going through and fleshing out those skeletons. All plugins in that branch have at least skeleton docu, and the first half of the plugins (up to http_functions) have more complete, corrected documentation (because the auto-generated skeletons aren't perfect, but they saved me a lot of work).
So, if someone wants to checkout that branch and build the html and look at the first half of the plugins' documentation and provide feedback, that would be excellent. The docu currently breaks "make html", but that's because it's not finished yet. And there's other little inaccuracies that will be fixed later. What's important at this stage is: do you like the general layout and contents? As you'll see, the plugin docs follow a pretty standard format. The addition of a Variables section is new and important, imho, because people want to know about a plugin's variables as much as its command line options. Also, there are many plugins that don't have any variables, or have variables that aren't connected to command line options and vice versa, etc. I also added a Changelog section because in the long run tracking changes to plugins will be very important. If there are no major objections, I'll continue and hopefully soon we'll have a lot more plugin documentation than ever before. The current stuff may not be perfect, but it's a lot better than no documentation at all. -Daniel _______________________________________________ Mailing list: https://launchpad.net/~drizzle-discuss Post to : drizzle-discuss@lists.launchpad.net Unsubscribe : https://launchpad.net/~drizzle-discuss More help : https://help.launchpad.net/ListHelp
