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
+17Lines changed: 17 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -130,3 +130,20 @@ $ bin/yard server --reload
130
130
131
131
Then navigate to `localhost:8808` to view the rendered docs.
132
132
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`
0 commit comments