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
Copy file name to clipboardExpand all lines: DEVELOPMENT.md
+27Lines changed: 27 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -130,3 +130,30 @@ $ bin/yard server --reload
130
130
131
131
Then navigate to `localhost:8808` to view the rendered docs.
132
132
133
+
### Publishing the documentation
134
+
135
+
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
+
143
+
> `cd .. && git clone https://github.com/rspec/rspec.github.io && cd rspec.github.io`
144
+
145
+
2) Check out the [source branch](https://github.com/rspec/rspec.github.io/tree/source)
146
+
147
+
> `git checkout source`
148
+
149
+
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).
150
+
151
+
> `gem build yard-rspec-docs-template.gemspec`
152
+
153
+
4) Change back to the `rspec-rails` directory
154
+
155
+
> `cd ../rspec-rails`
156
+
157
+
5) Generate the docs for the version you want, ensuring you are on the appropriate (released) commit.
0 commit comments