Contents

require 'pathname'

require 'jazzy/jazzy_markdown'
require 'jazzy/source_document'

module Jazzy
  module DocumentationGenerator
    extend Config::Mixin

    def self.source_docs
      documentation_entries.map do |file_path|
        SourceDocument.new.tap do |sd|
          sd.name = File.basename(file_path, '.md')
          sd.url = sd.name.downcase.strip
                     .tr(' ', '-').gsub(/[^\w-]/, '') + '.html'
          sd.type = SourceDeclaration::Type.new 'document.markdown'
          sd.children = []
          sd.overview = overview Pathname(file_path)
          sd.usr = 'documentation.' + sd.name
          sd.abstract = ''
          sd.return = ''
          sd.parameters = []
        end
      end
    end

    def self.overview(file_path)
      return '' unless file_path && file_path.exist?
      file_path.read
    end

    def self.documentation_entries
      return [] unless
        config.documentation_glob_configured && config.documentation_glob
      config.documentation_glob.select { |e| File.file? e }
    end
  end
end

Version data entries

17 entries across 17 versions & 1 rubygems

Version	Path
jazzy-0.9.4	lib/jazzy/documentation_generator.rb
jazzy-0.9.3	lib/jazzy/documentation_generator.rb
jazzy-0.9.2	lib/jazzy/documentation_generator.rb
jazzy-0.9.1	lib/jazzy/documentation_generator.rb
jazzy-0.9.0	lib/jazzy/documentation_generator.rb
jazzy-0.8.4	lib/jazzy/documentation_generator.rb
jazzy-0.8.3	lib/jazzy/documentation_generator.rb
jazzy-0.8.2	lib/jazzy/documentation_generator.rb
jazzy-0.8.1	lib/jazzy/documentation_generator.rb
jazzy-0.8.0	lib/jazzy/documentation_generator.rb
jazzy-0.7.5	lib/jazzy/documentation_generator.rb
jazzy-0.7.4	lib/jazzy/documentation_generator.rb
jazzy-0.7.3	lib/jazzy/documentation_generator.rb
jazzy-0.7.2	lib/jazzy/documentation_generator.rb
jazzy-0.7.1	lib/jazzy/documentation_generator.rb
jazzy-0.7.0	lib/jazzy/documentation_generator.rb
jazzy-0.6.3	lib/jazzy/documentation_generator.rb