class Fastlane::Actions::JazzyAction

Public Class Methods

authors() click to toggle source
# File fastlane/lib/fastlane/actions/jazzy.rb, line 37
def self.authors
  ["KrauseFx"]
end
available_options() click to toggle source
# File fastlane/lib/fastlane/actions/jazzy.rb, line 19
def self.available_options
  [
    FastlaneCore::ConfigItem.new(
      key: :config,
      env_name: 'FL_JAZZY_CONFIG',
      description: 'Path to jazzy config file',
      is_string: true,
      optional: true
    )
  ]
end
category() click to toggle source
# File fastlane/lib/fastlane/actions/jazzy.rb, line 51
def self.category
  :documentation
end
description() click to toggle source

@!group Documentation

# File fastlane/lib/fastlane/actions/jazzy.rb, line 15
def self.description
  "Generate docs using Jazzy"
end
example_code() click to toggle source
# File fastlane/lib/fastlane/actions/jazzy.rb, line 45
def self.example_code
  [
    'jazzy'
  ]
end
is_supported?(platform) click to toggle source
# File fastlane/lib/fastlane/actions/jazzy.rb, line 41
def self.is_supported?(platform)
  [:ios, :mac].include?(platform)
end
output() click to toggle source
# File fastlane/lib/fastlane/actions/jazzy.rb, line 31
def self.output
end
return_value() click to toggle source
# File fastlane/lib/fastlane/actions/jazzy.rb, line 34
def self.return_value
end
run(params) click to toggle source
# File fastlane/lib/fastlane/actions/jazzy.rb, line 4
def self.run(params)
  Actions.verify_gem!('jazzy')
  command = "jazzy"
  command << " --config #{params[:config]}" if params[:config]
  Actions.sh(command)
end