summaryrefslogtreecommitdiffstats
path: root/bin/puppetdoc
Commit message (Collapse)AuthorAgeFilesLines
* [#4196] Move the docs into the source directory structureJesse Wolfe2010-07-091-64/+0
| | | | | | Since it is no longer possible to find the running executable from the call stack, docs have to be kept somewhere in the source tree. Of course, at this point, we shouldn't be using RDoc::Usage at all.
* Fix #3932 - Add --charset to puppetdoc for RDoc modeBrice Figureau2010-02-171-1/+4
| | | | | | | This adds the --charset option to puppetdoc for RDoc mode. This allows to set the charset for the generated html. Signed-off-by: Brice Figureau <brice-puppet@daysofwonder.com>
* feature #2276 Single Executable: help infoJesse Wolfe2010-02-171-8/+8
| | | | | | Change the --help text to match the new single executable invocations Signed-off-by: Jesse Wolfe <jes5199@gmail.com>
* Renaming applications, mostly removing 'puppet'Luke Kanies2010-02-171-2/+2
| | | | Signed-off-by: Luke Kanies <luke@madstop.com>
* Added Markdown mode to puppetdoc to output Markdown.James Turnbull2009-07-101-2/+4
| | | | Requires the pandoc binary to function (http://johnmacfarlane.net/pandoc/).
* Removed extra whitespace from end of linesIan Taylor2009-06-061-2/+2
|
* Move puppetdoc to the Application Controller paradigmBrice Figureau2009-02-161-195/+2
| | | | Signed-off-by: Brice Figureau <brice-puppet@daysofwonder.com>
* Manifest documentation generationBrice Figureau2008-11-171-15/+109
| | | | | | | | | | | | | | | | | | | | | | | | There is currently two type of documentation generation for manifests (module or modulepath): * RDoc HTML generation for modules and global manifests * console output for sole manifest Both version handles classes, defines, nodes, global variable assignements, and resources when --all is used. The usage is the following: For the rdoc variant: $ puppetdoc --mode rdoc --outputdir doc It uses the puppet.conf configuration file to get the modulepath and manifestdir settings. Those are overridable on the command line with --modulepath and --manifestdir. For the console output version: $ puppetdoc /path/to/manifests Signed-off-by: Brice Figureau <brice-puppet@daysofwonder.com>
* Removing obsolete references (they're in the indirectionLuke Kanies2008-02-131-4/+14
| | | | reference), and adding error handling to puppetdoc.
* Fixing #886 -- the problem was the I had changed the baseLuke Kanies2007-11-231-27/+27
| | | | | class for Parameter, which apparently lost the 'nodoc' method for that class.
* Removing the Id tags from all of the filesLuke Kanies2007-10-031-1/+0
|
* Intermediate commit of more reference work, including making provider ↵luke2007-05-081-4/+19
| | | | | | suitable more introspectable. I am about to significantly change the output format of the providers reference, so i want to get this committed before that change. git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2485 980ebf18-57e1-0310-9a29-db15c13687c0
* Adding a dynamic? option for references, so those are not stored in tracluke2007-05-071-1/+4
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2480 980ebf18-57e1-0310-9a29-db15c13687c0
* First run at moving references to lib/puppet instead of puppetdocluke2007-05-071-514/+27
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2477 980ebf18-57e1-0310-9a29-db15c13687c0
* Fixing #206 and #422. Executables will still look for the deprecated config ↵luke2007-05-061-8/+26
| | | | | | files and load them using the old parse method, but they now prefer a single configuration file, and files can set parameters (owner, mode, group) in brackets on the same line. git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2464 980ebf18-57e1-0310-9a29-db15c13687c0
* Correcting function reference markupluke2007-05-041-1/+2
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2462 980ebf18-57e1-0310-9a29-db15c13687c0
* Adding a note to the references indicating that they are autogenerated.luke2007-04-241-0/+1
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2412 980ebf18-57e1-0310-9a29-db15c13687c0
* Refactoring puppetdoc so it is a bit cleaner and is actually ↵luke2007-04-241-200/+251
| | | | | | object-oriented. PDF output still fails miserably (there has to be some kind of markup problem, but I have no idea what), but other output now successfully varies on the pages. git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2411 980ebf18-57e1-0310-9a29-db15c13687c0
* Last modifications to rst conversion before bedtimeluke2007-04-241-20/+34
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2410 980ebf18-57e1-0310-9a29-db15c13687c0
* All conversions to RST are done, but I did not quite succeed at making ↵luke2007-04-241-37/+93
| | | | | | puppetdoc able to generate a single PDF with all of the references in them. git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2409 980ebf18-57e1-0310-9a29-db15c13687c0
* Mostly done with the conversion to restructured text, but there are still ↵luke2007-04-241-57/+68
| | | | | | some tweaks to perform on the typedocs output. git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2408 980ebf18-57e1-0310-9a29-db15c13687c0
* Translating all of the docs except the type docs to RSTluke2007-04-231-8/+178
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2406 980ebf18-57e1-0310-9a29-db15c13687c0
* Fixing puppetdoc with the recent changes to the networking codeluke2007-03-281-1/+2
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2360 980ebf18-57e1-0310-9a29-db15c13687c0
* Adding provider features. Woot!luke2007-03-191-19/+30
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2313 980ebf18-57e1-0310-9a29-db15c13687c0
* Moving all of the client and server code into a single network/ directory. ↵luke2007-02-081-1/+1
| | | | | | In other words, more code structure cleanup. git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2179 980ebf18-57e1-0310-9a29-db15c13687c0
* Fixing #346 -- on some scripts I accidentally used "feature" instead of ↵luke2006-11-161-1/+1
| | | | | | "features" git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1886 980ebf18-57e1-0310-9a29-db15c13687c0
* Slightly more doc updatesluke2006-11-091-105/+0
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1846 980ebf18-57e1-0310-9a29-db15c13687c0
* Small fixes here and there. The rails changes needs to be pushed through ↵luke2006-11-091-1/+1
| | | | | | the collection code, so I am committing so Blake can take a look at that. git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1844 980ebf18-57e1-0310-9a29-db15c13687c0
* Refactoring the doc generator a bigluke2006-11-091-32/+17
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1842 980ebf18-57e1-0310-9a29-db15c13687c0
* Merging the code over from the oscar branch. I will now be doing all ↵luke2006-11-081-12/+1
| | | | | | development in the trunk again, except for larger changes, which will still get their own branch. This is a merge of the changes from revision 1826 to revision 1834. git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1835 980ebf18-57e1-0310-9a29-db15c13687c0
* New documentation hierarchy.ajax2006-10-121-2/+2
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1770 980ebf18-57e1-0310-9a29-db15c13687c0
* Documented signals the puppet daemons acceptajax2006-10-051-2/+18
| | | | | | | Documented host type to make it clear ipv6 is supported git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1737 980ebf18-57e1-0310-9a29-db15c13687c0
* Expanded documentation of command-line arguments for the puppet executables. ↵ajax2006-09-251-12/+10
| | | | | | (Tweak) git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1688 980ebf18-57e1-0310-9a29-db15c13687c0
* Expanded documentation of command-line arguments for the puppet executables.ajax2006-09-251-1/+60
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1686 980ebf18-57e1-0310-9a29-db15c13687c0
* Adding an Autoload instance to Type.rb so that I can load all known types ↵luke2006-09-211-0/+5
| | | | | | for documentation purposes. And, of course, loading all types in puppetdoc. Also updating zone.rb to fix markdown's stupidity in trying to interpret the ERB template, and adding some timeouts to puppettest.rb git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1651 980ebf18-57e1-0310-9a29-db15c13687c0
* Specifically rescuing Exception, since apparently the default does not ↵luke2006-09-151-1/+1
| | | | | | rescue LoadErrors and everything else git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1604 980ebf18-57e1-0310-9a29-db15c13687c0
* Catching all errors encountered during loading, not just LoadError, to fix ↵luke2006-09-141-1/+1
| | | | | | ongoing problems with rdoc/usage. git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1593 980ebf18-57e1-0310-9a29-db15c13687c0
* Adding a module specifically for making doc generation easier, and adding ↵luke2006-08-281-0/+5
| | | | | | defaults info to provider docs. git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1504 980ebf18-57e1-0310-9a29-db15c13687c0
* fixing puppetdoc to add ordering infoluke2006-07-311-0/+2
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1434 980ebf18-57e1-0310-9a29-db15c13687c0
* Fixing puppetdoc's outputluke2006-07-211-3/+4
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1410 980ebf18-57e1-0310-9a29-db15c13687c0
* More documentation updates. I think this is sufficient for replacement of ↵luke2006-07-061-38/+45
| | | | | | the plone site. git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1373 980ebf18-57e1-0310-9a29-db15c13687c0
* changing the #!ruby lines to #!env rubyluke2006-06-291-1/+1
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1338 980ebf18-57e1-0310-9a29-db15c13687c0
* More documentation changes.luke2006-06-191-8/+8
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1300 980ebf18-57e1-0310-9a29-db15c13687c0
* updating some docs and puppetdoc in preparation for a move to webgen instead ↵luke2006-06-171-17/+15
| | | | | | of plone git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1295 980ebf18-57e1-0310-9a29-db15c13687c0
* Updating doc system to add the list of valid values to the doc string, and ↵luke2006-05-101-2/+13
| | | | | | tweaking a few docs. git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1183 980ebf18-57e1-0310-9a29-db15c13687c0
* Adding doc generation for exe argumentsluke2006-04-111-108/+160
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1110 980ebf18-57e1-0310-9a29-db15c13687c0
* fixing a couple small bugs in doc generationluke2006-04-051-1/+6
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@1078 980ebf18-57e1-0310-9a29-db15c13687c0
* Adding an "ensure" state where appropriate, and significantly reworking the ↵luke2006-01-171-14/+85
| | | | | | builtin docs. git-svn-id: https://reductivelabs.com/svn/puppet/trunk@832 980ebf18-57e1-0310-9a29-db15c13687c0
* Fixing up the parsedtypes, fixing Type.eachtype to ignore structure typesluke2006-01-131-10/+15
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@822 980ebf18-57e1-0310-9a29-db15c13687c0
* Lots of refactoring, and added the capture_stderr methodluke2005-11-161-2/+4
| | | | git-svn-id: https://reductivelabs.com/svn/puppet/trunk@742 980ebf18-57e1-0310-9a29-db15c13687c0