Sha256: 8df854aec98e3e9266042b3bb61dd70ae53379fe61eeb8a6f285cb2f2c475f91
Contents?: true
Size: 1.51 KB
Versions: 4
Compression:
Stored size: 1.51 KB
Contents
# frozen_string_literal: true require 'puppet-strings/json' # module for parsing Yard Registries and generating markdown module PuppetStrings::Markdown require_relative 'markdown/puppet_classes' require_relative 'markdown/functions' require_relative 'markdown/defined_types' require_relative 'markdown/data_types' require_relative 'markdown/resource_types' require_relative 'markdown/puppet_tasks' require_relative 'markdown/puppet_plans' require_relative 'markdown/table_of_contents' # generates markdown documentation # @return [String] markdown doc def self.generate final = "# Reference\n\n" final += "<!-- DO NOT EDIT: This document was generated by Puppet Strings -->\n\n" final += PuppetStrings::Markdown::TableOfContents.render final += PuppetStrings::Markdown::PuppetClasses.render final += PuppetStrings::Markdown::DefinedTypes.render final += PuppetStrings::Markdown::ResourceTypes.render final += PuppetStrings::Markdown::Functions.render final += PuppetStrings::Markdown::DataTypes.render final += PuppetStrings::Markdown::PuppetTasks.render final += PuppetStrings::Markdown::PuppetPlans.render final end # mimicks the behavior of the json render, although path will never be nil # @param [String] path path to destination file def self.render(path = nil) if path.nil? puts generate exit else File.open(path, 'w') { |file| file.write(generate) } YARD::Logger.instance.debug "Wrote markdown to #{path}" end end end
Version data entries
4 entries across 4 versions & 1 rubygems