class Fastlane::Actions::JazzyAction
Public Class Methods
available_options()
click to toggle source
# File fastlane/lib/fastlane/actions/jazzy.rb, line 20 def self.available_options [ FastlaneCore::ConfigItem.new(key: :config, env_name: 'FL_JAZZY_CONFIG', description: 'Path to jazzy config file', optional: true), FastlaneCore::ConfigItem.new(key: :module_version, env_name: 'FL_JAZZY_MODULE_VERSION', description: 'Version string to use as part of the the default docs title and inside the docset', optional: true) ] end
category()
click to toggle source
# File fastlane/lib/fastlane/actions/jazzy.rb, line 54 def self.category :documentation end
description()
click to toggle source
@!group Documentation
# File fastlane/lib/fastlane/actions/jazzy.rb, line 16 def self.description "Generate docs using Jazzy" end
example_code()
click to toggle source
# File fastlane/lib/fastlane/actions/jazzy.rb, line 47 def self.example_code [ 'jazzy', 'jazzy(config: ".jazzy.yaml", module_version: "2.1.37")' ] end
is_supported?(platform)
click to toggle source
# File fastlane/lib/fastlane/actions/jazzy.rb, line 43 def self.is_supported?(platform) [:ios, :mac].include?(platform) end
output()
click to toggle source
# File fastlane/lib/fastlane/actions/jazzy.rb, line 33 def self.output end
return_value()
click to toggle source
# File fastlane/lib/fastlane/actions/jazzy.rb, line 36 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] command << " --module-version #{params[:module_version]}" if params[:module_version] Actions.sh(command) end