Skip to content

Commit d48db33

Browse files
committed
Document how we generate documentation to rspec.github.io
Dependent: - rspec/rspec.github.io#137
1 parent eb3377b commit d48db33

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

DEVELOPMENT.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,3 +130,19 @@ $ bin/yard server --reload
130130

131131
Then navigate to `localhost:8808` to view the rendered docs.
132132

133+
### Publish documentation to rspec.github.io
134+
135+
In other documented rspec gems, we use a rake command from rspec-dev
136+
to generate documentation. `rspec-rails` is no more synced with
137+
other gems in term of version. If you want to update the documentation
138+
to [`rspec.github.io`](https://github.com/rspec/rspec.github.io) you
139+
need to git clone in the parent folder of rspec-rails the `rspec.github.io`
140+
repository. You also need from [source branch](https://github.com/rspec/rspec.github.io/tree/source)
141+
the gem that will be needed as yard plugin: [rspec-docs-template](https://github.com/rspec/rspec.github.io#install-rspec-docs-template-yard-plugin).
142+
143+
* `git clone https://github.com/rspec/rspec.github.io && cd rspec.github.io`
144+
* `git checkout source`
145+
* `gem build yard-rspec-docs-template.gemspec`
146+
* `cd ../rspec-rails`
147+
* `bundle exec rake "update_docs[4.0, 4-0-maintenance]`
148+

0 commit comments

Comments
 (0)