Skip to content

Latest commit

 

History

History
executable file
·
34 lines (24 loc) · 1.03 KB

settings.md

File metadata and controls

executable file
·
34 lines (24 loc) · 1.03 KB
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)

DOCSTRING_FORMAT

Use DOCSTRING_FORMAT to configure the format you follow for the docstrings. Supported formats are:

  • text: Plain text
  • rst: reStructuredText

List of Settings

Setting Type Options Default
HIDE_DOCS Boolean True, False False
DOCSTRING_FORMAT String 'text', 'rst' 'text'