Skip to content

add warning for config.docs_dir #442

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 10, 2020
Merged

add warning for config.docs_dir #442

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@ RspecApiDocumentation.configure do |config|
config.configurations_dir = Rails.root.join("doc", "configurations", "api")

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

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

# Change the filter to only include :public examples
Expand Down