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

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
Fixed build errors
  • Loading branch information
@prijip
prijip committed Jul 23, 2016
commit 35ca9db602fb74b92e08112472008994f901b666
4 changes: 2 additions & 2 deletions rest_framework_docs/api_endpoint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
from django.contrib.admindocs.views import simplify_regex
from django.utils.encoding import force_str
from rest_framework.serializers import BaseSerializer

from django.utils.safestring import mark_safe
from docutils import core


class ApiEndpoint(object):

def __init__(self, pattern, parent_pattern=None, drf_router=None, docstring_format=None):
Expand Down Expand Up @@ -71,7 +71,7 @@ def __get_allowed_methods__(self):

def __get_docstring__(self):
description = inspect.getdoc(self.callback)
if (self.docstring_format == "rst"): # reStructuredText
if (self.docstring_format == "rst"): # reStructuredText
parts = core.publish_parts(source=description, writer_name="html")
html = parts["body_pre_docinfo"] + parts["fragment"]
description = mark_safe(html)
Expand Down