Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add metadata #308

Closed
wants to merge 1 commit into from
Closed

add metadata #308

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions gli.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ spec = Gem::Specification.new do |s|
s.summary = "Build command-suite CLI apps that are awesome."
s.description = "Build command-suite CLI apps that are awesome. Bootstrap your app, add commands, options and documentation while maintaining a well-tested idiomatic command-line app"

s.metadata = {
'yard.run' => 'yard',
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's this one do? Is it just "what command do I run to do yard doc generation?"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can also add the following to your .gemspec to have YARD document your gem
on install:

spec.metadata["yard.run"] = "yri" # use "yard" to build full HTML docs.

or

lsegal/yard#1187

'bug_tracker_uri' => 'https://github.com/davetron5000/gli/issues',
'changelog_uri' => 'https://github.com/davetron5000/gli/releases',
'documentation_uri' => 'https://www.rubydoc.info/gems/gli/',
'homepage_uri' => 'https://davetron5000.github.com/gli/',
'source_code_uri' => 'https://github.com/davetron5000/gli/'
}

s.files = `git ls-files`.split("\n")
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
s.require_paths = ["lib"]
Expand Down