Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
 
 
Cannot retrieve contributors at this time
source_filename
settings

How to set the settings

To set DRF docs' settings just include the dictionary below in Django's settings.py file.

REST_FRAMEWORK_DOCS = {
    'HIDE_DOCS': True
}

Settings Description

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('HIDE_DRFDOCS', False)
}

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

List of Settings

Setting Type Options Default
HIDE_DOCS Boolean True, False False