Sha256: 2dc630161042b5bdd1ef31c6a4b6dbe087421fe323c11a0d562164c08bdf0158

Contents?: true

Size: 1.06 KB

Versions: 18

Compression:

Stored size: 1.06 KB

Contents

module Pantograph
  module Actions
    class SkipDocsAction < Action
      def self.run(params)
        ENV["PANTOGRAPH_SKIP_DOCS"] = "1"
      end

      def self.step_text
        nil
      end

      #####################################################
      # @!group Documentation
      #####################################################

      def self.description
        "Skip the creation of the pantograph/README.md file when running pantograph"
      end

      def self.available_options
      end

      def self.output
      end

      def self.return_value
      end

      def self.details
        "Tell _pantograph_ to not automatically create a `pantograph/README.md` when running _pantograph_. You can always trigger the creation of this file manually by running `pantograph docs`."
      end

      def self.authors
        ["KrauseFx"]
      end

      def self.is_supported?(platform)
        true
      end

      def self.example_code
        [
          'skip_docs'
        ]
      end

      def self.category
        :misc
      end
    end
  end
end

Version data entries

18 entries across 18 versions & 1 rubygems

Version Path
pantograph-0.1.22 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.21 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.20 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.19 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.17 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.16 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.15 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.14 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.13 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.12 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.10 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.8 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.7 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.6 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.4 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.3 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.1 pantograph/lib/pantograph/actions/skip_docs.rb
pantograph-0.1.0 pantograph/lib/pantograph/actions/skip_docs.rb