Skip to content

Commit c1d1e24

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

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

DEVELOPMENT.md

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

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

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

0 commit comments

Comments
 (0)