Contents

# rake decko:docs:...

# NOTE: for the moment these are Platypus tasks.
# Until they're more monkey friendly, let's not write `desc` descriptions.
# Without those they won't show up when folks run `rake -T`
#
# Make sure: you're:
#   (A) running in a development environment, and
#   (B) pointing to a repo gem
namespace :decko do
  namespace :docs do
    # Triggers tmpsets and then runs yardoc
    #
    # IMPORTANT: Only works if using source code from github.
    task :update do
      Cardio.config.load_strategy = :tmp_files
      Rake::Task["decko:docs:dummy"].invoke
      Rake::Task["decko:docs:yardoc"].invoke
    end

    # Runs yardoc command, which generates the docs content in the repo root.
    #
    # IMPORTANT: Only works if using source code from github.
    # If you run this while using decko as a built gem, you could get some funky docs in
    # your gems directory...
    task :yardoc do
      doc_dir = File.expand_path "..", Decko.gem_root
      system %(cd #{doc_dir}; yardoc)
    end

    # just load environment and trigger Card load (used to generate tmpsets)
    task dummy: :environment do
      Card
    end
  end
end

Version data entries

12 entries across 12 versions & 1 rubygems

Version	Path
decko-0.18.1	lib/rake_tasks/decko/docs.rake
decko-0.18.0	lib/rake_tasks/decko/docs.rake
decko-0.17.0	lib/rake_tasks/decko/docs.rake
decko-0.16.0	lib/rake_tasks/decko/docs.rake
decko-0.15.6	lib/rake_tasks/decko/docs.rake
decko-0.15.5	lib/rake_tasks/decko/docs.rake
decko-0.15.4	lib/rake_tasks/decko/docs.rake
decko-0.15.3	lib/rake_tasks/decko/docs.rake
decko-0.15.2.pre1	lib/rake_tasks/decko/docs.rake
decko-0.15.1.1	lib/rake_tasks/decko/docs.rake
decko-0.15.1	lib/rake_tasks/decko/docs.rake
decko-0.15.0	lib/rake_tasks/decko/docs.rake