Skip to content
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.

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

DocString Formatting for Description #124

Open
psyonara opened this issue Jul 28, 2016 · 6 comments
Open

DocString Formatting for Description #124

psyonara opened this issue Jul 28, 2016 · 6 comments

Comments

@psyonara
Copy link

How do I format the description of an endpoint for when DRF Docs displays it? I've tried several things and nothing works. For example, I'd like to add line breaks. Is there a way to do this?
Thanks

@ianoboyle
Copy link

Did you ever find a solution to this? I am very interested...

@psyonara
Copy link
Author

No, not yet. :(

@ianoboyle
Copy link

I did come across these threads...

#117

http://www.django-rest-framework.org/topics/documenting-your-api/

supposedly if you have markdown installed you can use markdown in the docstrings of your api...
I haven't tried using it yet but I hope this is still relevant to you!

@mytrhan
Copy link

mytrhan commented Jun 15, 2017

Hello! Any solution to this? I'm stuck at the same point :(

@mytrhan
Copy link

mytrhan commented Jun 21, 2017

Turns out the version available in pip repos is older and still does not support description markdown formatting.

To enable it you have to download the latest version from git and install it manually.
git clone https://github.com/manosim/django-rest-framework-docs.git
pip install -r django-rest-framework-docs/requirements.txt
pip install -e django-rest-framework-docs/

Note that django-rest-framework-docs/requirements.txt contains:
Django==1.8.7
djangorestframework==3.3.2

If you have different versions of Django or djangorestframework you can remove them.

@exc4
Copy link

exc4 commented Jul 31, 2017

@mytrhan, I tried ur method, didn't work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants