Piktur Docs

piktur-docs piktur-docs-staging

Build documentation for Piktur libraries locally with:

  rake yard:all
  rake yard:piktur_core

Fetch source from remote repository rake yard:prepare

Start documentation server RACK_ENV=development rackup

---

Yard Cheatsheet

Snippets

Generate symbolic link to nested README

  %w(api admin blog client core store).each do |app|
    f = Rails.root.join("../piktur_#{app}/README.markdown")
    destination = Pathname(File.join(*f.to_s.rpartition("piktur_#{app}").insert(1, 'docs')))
    FileUtils.mkdir_p(destination.parent) unless destination.parent.exist?
    File.symlink(f, destination)
  end