Skip to content

Minor documentation update #75

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 2 commits into from
Mar 24, 2016
Merged

Minor documentation update #75

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6204182
Update settings.md
ambivalentno Mar 22, 2016
59d88bb
fix
ambivalentno Mar 24, 2016
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
6 changes: 3 additions & 3 deletions docs/settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ To set DRF docs' settings just include the dictionary below in Django's `setting

### Settings Description

##### HIDDEN
##### HIDE_DOCS
You can use hidden to prevent your docs from showing up in different environments (ie. Show in development, hide in production). To do so you can use environment variables.

REST_FRAMEWORK_DOCS = {
'HIDE_DOCS': os.environ.get('SHOW_DRFDOCS', False)
'HIDE_DOCS': os.environ.get('HIDE_DRFDOCS', False)
}

Then set the value of the environment variable `SHOW_DRFDOCS` for each environment (ie. Use `.env` files)
Then set the value of the environment variable `HIDE_DRFDOCS` for each environment (ie. Use `.env` files)

### List of Settings

Expand Down