kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #175 from eputnam/pdoc238 

(PDOC-238) add generated message to markdown
This commit is contained in:
willmeek 2018-04-23 16:33:46 +01:00 committed by GitHub
parent 8ce914ee71 2d59213b34
commit d4e743dbad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
lib/puppet-strings/markdown.rb
View File

@ -13,7 +13,8 @@ module PuppetStrings::Markdown
# generates markdown documentation # generates markdown documentation
# @return [String] markdown doc # @return [String] markdown doc
def self.generate def self.generate
final = "# Reference\n\n" final = "# Reference\n"
final << "<!-- DO NOT EDIT: This document was generated by Puppet Strings -->\n\n"
final << PuppetStrings::Markdown::TableOfContents.render final << PuppetStrings::Markdown::TableOfContents.render
final << PuppetStrings::Markdown::PuppetClasses.render final << PuppetStrings::Markdown::PuppetClasses.render
final << PuppetStrings::Markdown::DefinedTypes.render final << PuppetStrings::Markdown::DefinedTypes.render

1
spec/fixtures/unit/markdown/output.md vendored
View File

@ -1,4 +1,5 @@
# Reference # Reference
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
## Classes ## Classes

1
spec/fixtures/unit/markdown/output_with_plan.md vendored
View File

@ -1,4 +1,5 @@
# Reference # Reference
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
## Classes ## Classes