You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In the other documented rspec gems, we use a rake command in rspec-dev
136
+
to generate documentation for [rspec.info](https://rspec.info/).
137
+
As `rspec-rails` is no longer sync with the other gems in terms of versioning
138
+
since `rspec-rails` 4, if you want to publish updated documentation you will
139
+
need to run the rake task from this repository.
140
+
141
+
1) First clone the `rspec.github.io` repository into a sibling folder.
142
+
`cd .. && git clone https://github.com/rspec/rspec.github.io && cd rspec.github.io`
143
+
144
+
2) Check out the [source branch](https://github.com/rspec/rspec.github.io/tree/source)
145
+
`git checkout source`
146
+
147
+
3) Install the template gem that will be needed as yard plugin: [rspec-docs-template](https://github.com/rspec/rspec.github.io#install-rspec-docs-template-yard-plugin).
148
+
`gem build yard-rspec-docs-template.gemspec`
149
+
150
+
4) Change back to the `rspec-rails` directory
151
+
`cd ../rspec-rails`
152
+
153
+
5) Generate the docs for the version you want, ensuring you are on the appropriate (released) commit.
0 commit comments