Skip to content

Add command to update rspec.github.io docs. #109

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.

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

Merged
merged 1 commit into from
Jan 28, 2015
Merged

Conversation

myronmarston
Copy link
Member

This adds a command that will regenerate all the YARD docs for rspec.github.io:

$ bundle exec rake "update_docs[3.2, master]"
# or
$ bundle exec rake "update_docs[3.1, 3-1-maintenance]"

Longer term we might want to hook it into the release tasks so the docs are auto-updated but this seemed a good first step.

/cc @JonRowe

@@ -56,6 +57,17 @@ task :run, :command do |t, args|
run_command args[:command]
end

desc "Updates the rspec.github.io docs"
task :update_docs, [:version, :branch, :website_path] do |t, args|
args.with_defaults(:website_path => "../rspec.github.io")
Copy link
Member Author

Choose a reason for hiding this comment

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

I remember before you had the website checked out as rspec-website. You can pass a 3rd arg to set your path, but I figured rspec.github.io (what I have it cloned as) is more typical since that's the project name on github. Or you can just rename your rspec-website directory :).

Copy link
Member

Choose a reason for hiding this comment

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

I don't use the rspec-dev tools except for travis stuff so you're good ;)

Copy link
Member Author

Choose a reason for hiding this comment

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

Would you prefer a different way to update the docs?

Copy link
Member

Choose a reason for hiding this comment

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

Nope, this is good, I use rspec-dev for things like this and just let it do it's thing, I just develop elsewhere.

myronmarston added a commit that referenced this pull request Jan 28, 2015
Add command to update rspec.github.io docs.
@myronmarston myronmarston merged commit b27dca2 into master Jan 28, 2015
@myronmarston myronmarston deleted the update-docs branch January 28, 2015 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants