File tree 2 files changed +10
-4
lines changed
2 files changed +10
-4
lines changed Original file line number Diff line number Diff line change @@ -59,6 +59,7 @@ You can find detailed information about the package's settings at [the docs](htt
59
59
60
60
REST_FRAMEWORK_DOCS = {
61
61
'HIDE_DOCS': True # Default: False
62
+ 'DOCSTRING_FORMAT': 'rst' # Default: 'text'
62
63
}
63
64
64
65
Original file line number Diff line number Diff line change @@ -21,9 +21,14 @@ You can use hidden to prevent your docs from showing up in different environment
21
21
22
22
Then set the value of the environment variable ` HIDE_DRFDOCS ` for each environment (ie. Use ` .env ` files)
23
23
24
+ ##### DOCSTRING_FORMAT
25
+ Use DOCSTRING_FORMAT to configure the format you follow for the docstrings. Supported formats are:
26
+ - * text* : Plain text
27
+ - * rst* : reStructuredText
28
+
24
29
### List of Settings
25
30
26
- | Setting | Type | Options | Default |
27
- | ---------| ---------| -----------------| ---------|
28
- | HIDE_DOCS| Boolean | ` True ` , ` False ` | ` False ` |
29
- | | | | |
31
+ | Setting | Type | Options | Default |
32
+ | ---------------- | ---------| -----------------| ---------|
33
+ | HIDE_DOCS | Boolean | ` True ` , ` False ` | ` False ` |
34
+ | DOCSTRING_FORMAT | String | 'text', 'rst' | 'text' |
You can’t perform that action at this time.
0 commit comments