Skip to content

Support restructuredtext #121

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Support restructuredtext #121

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bb4258e
Support reStructuredText in docstring
prijip Jul 22, 2016
6f1751d
Added setting DOCSTRING_FORMAT
prijip Jul 22, 2016
faa36c5
Added documentation for setting DOCSTRING_FORMAT
prijip Jul 22, 2016
35ca9db
Fixed build errors
prijip Jul 23, 2016
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Added documentation for setting DOCSTRING_FORMAT
  • Loading branch information
@prijip
prijip committed Jul 22, 2016
commit faa36c5191ef164e1eee9228fe08a7218b522b84
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ You can find detailed information about the package's settings at [the docs](htt

REST_FRAMEWORK_DOCS = {
'HIDE_DOCS': True # Default: False
'DOCSTRING_FORMAT': 'rst' # Default: 'text'
}


Expand Down
13 changes: 9 additions & 4 deletions docs/settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,14 @@ You can use hidden to prevent your docs from showing up in different environment

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` |
| | | | |
| Setting | Type | Options | Default |
|----------------|---------|-----------------|---------|
|HIDE_DOCS | Boolean | `True`, `False` | `False` |
|DOCSTRING_FORMAT| String | 'text', 'rst' | 'text' |