Skip to content

Commit faa36c5

Browse files
committed
Added documentation for setting DOCSTRING_FORMAT
1 parent 6f1751d commit faa36c5

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ You can find detailed information about the package's settings at [the docs](htt
5959

6060
REST_FRAMEWORK_DOCS = {
6161
'HIDE_DOCS': True # Default: False
62+
'DOCSTRING_FORMAT': 'rst' # Default: 'text'
6263
}
6364

6465

docs/settings.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,14 @@ You can use hidden to prevent your docs from showing up in different environment
2121

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

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+
2429
### List of Settings
2530

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' |

0 commit comments

Comments
 (0)