Making Rockspecs, HTML and RSS from a single source
Overview · Installation · Using Petrodoc · Contact · License
Making Rockspecs, HTML and RSS from a single source
Overview · Installation · Using Petrodoc · Contact · License
Petrodoc consists of a single file (petrodoc.lua). Here is a list of recent releases:
You can also install Petrodoc as a LuaRock from the repository at http://sputnik.freewisdom.org/rocks/galaxy/.
Petrodoc takes as input a single file that is similar to a LuaRocks rockspec but contains additional fields for generating documentation.
For example, to generate documentation for XSSFilter, we would use the following petrodoc file:
We would go into "lua-xssfilter" directory and run petrodoc.lua with "petrodoc" as the first argument.
This would give us:
For more information please contact the author, Yuri Takhteyev or write to the Sputnik Mailing List.
Comments are welcome!
Copyright (c) 2007, 2008 Yuri Takhteyev
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.