Skip to content

Add documentation about how to install rspec-docs-template yard plugin #137

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

Closed
wants to merge 1 commit into from
Closed

Add documentation about how to install rspec-docs-template yard plugin #137

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 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@ Requires a recent version of Ruby (> 2.1.x, tested on 2.5.3), bundler and imagem
* `bundle install`
* `middleman build`

## Install rspec-docs-template yard plugin

This plugin is needed when you run Rakefile command to generate documentation from
`rspec-dev` or `rspec-rails`.

From this repository:

`gem build yard-rspec-docs-template.gemspec`
Copy link
Member

Choose a reason for hiding this comment

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

As per my comment in rspec/rspec-rails#2298 I think it's ok to remove this.

Copy link
Member Author

Choose a reason for hiding this comment

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

So you want to replace this with ag command?

Copy link
Member

Choose a reason for hiding this comment

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

Thats in the rake task already

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes but it needs to be fixed. I will look at it.


## Local Developing

Run
Expand Down