Skip to content

Commit adb498a

Browse files
authored
Merge pull request #442 from zipmark/add_custom_dir_warning
add warning for `config.docs_dir`
2 parents a858252 + ce261dd commit adb498a

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

Diff for: README.md

+2
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,7 @@ RspecApiDocumentation.configure do |config|
185185
config.configurations_dir = Rails.root.join("doc", "configurations", "api")
186186

187187
# Output folder
188+
# **WARNING*** All contents of the configured directory will be cleared, use a dedicated directory.
188189
config.docs_dir = Rails.root.join("doc", "api")
189190

190191
# An array of output format(s).
@@ -238,6 +239,7 @@ RspecApiDocumentation.configure do |config|
238239
config.define_group :public do |config|
239240
# By default the group's doc_dir is a subfolder under the parent group, based
240241
# on the group's name.
242+
# **WARNING*** All contents of the configured directory will be cleared, use a dedicated directory.
241243
config.docs_dir = Rails.root.join("doc", "api", "public")
242244

243245
# Change the filter to only include :public examples

0 commit comments

Comments
 (0)