Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 6e49bd3

Browse files
author
Jens Timmerman
authored
Merge branch 'master' into master
2 parents b776596 + 876ac36 commit 6e49bd3

File tree

10 files changed

+33
-16
lines changed

10 files changed

+33
-16
lines changed

‎README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Document Web APIs made with Django Rest Framework. [View Demo](http://demo.drfdocs.com/)
44

5+
> **Contributors Wanted**: Do you like this project? Using it? Let's make it better!
6+
57
![DRFdocs](https://cloud.githubusercontent.com/assets/6333409/13193861/69e82aec-d778-11e5-95c4-77f4ef29e6e5.png)
68

79
### Supports
@@ -66,14 +68,14 @@ You can find detailed information about the package's settings at [the docs](htt
6668

6769
First of all thanks to the [Django](http://www.djangoproject.com/) core team and to all the contributors of [Django REST Framework](http://www.django-rest-framework.org/) for their amazing work. Also I would like to thank [Marc Gibbons](https://github.com/marcgibbons) for his *django-rest-framework-docs* project. Both projects share the same idea, it is just that Marc's is not maintained anymore and does not support DRF 3+ & Python 3.
6870

69-
[travis-image]: https://travis-ci.org/ekonstantinidis/django-rest-framework-docs.svg?branch=master
70-
[travis-url]: https://travis-ci.org/ekonstantinidis/django-rest-framework-docs
71+
[travis-image]: https://travis-ci.org/manosim/django-rest-framework-docs.svg?branch=master
72+
[travis-url]: https://travis-ci.org/manosim/django-rest-framework-docs
7173

7274
[pypi-image]: https://badge.fury.io/py/drfdocs.svg
7375
[pypi-url]: https://pypi.python.org/pypi/drfdocs/
7476

75-
[codecov-image]: https://codecov.io/github/ekonstantinidis/django-rest-framework-docs/coverage.svg?branch=master
76-
[codecov-url]:https://codecov.io/github/ekonstantinidis/django-rest-framework-docs?branch=master
77+
[codecov-image]: https://codecov.io/github/manosim/django-rest-framework-docs/coverage.svg?branch=master
78+
[codecov-url]:https://codecov.io/github/manosim/django-rest-framework-docs?branch=master
7779

7880
[slack-image]: https://img.shields.io/badge/slack-pythondev/drfdocs-e01563.svg
7981
[slack-url]: https://pythondev.slack.com

‎docs/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ source_filename: contributing
55
### Development
66
If you want to **use the demo** app to work on this package:
77

8-
In the project [repository](https://github.com/ekonstantinidis/django-rest-framework-docs) you can find the demo app(at /demo). It is a project with Django & Django Rest Framework that will allow you to work with this project.
8+
In the project [repository](https://github.com/manosim/django-rest-framework-docs) you can find the demo app(at /demo). It is a project with Django & Django Rest Framework that will allow you to work with this project.
99

1010
From the root of the repository:
1111

‎docs/template/base.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@
5656

5757
<footer class="col-md-12 footer">
5858
<div class="links">
59-
<a href="http://www.iamemmanouil.com"><i class="fa fa-link"></i></a>
60-
<a href="http://www.github.com/ekonstantinidis"><i class="fa fa-github"></i></a>
59+
<a href="http://www.manos.im/"><i class="fa fa-link"></i></a>
60+
<a href="http://www.github.com/manosim"><i class="fa fa-github"></i></a>
6161
<a href="http://www.twitter.com/iamemmanouil"><i class="fa fa-twitter"></i></a>
6262
</div>
6363
{% if copyright %}

‎docs/template/content.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@
1111
{{ content }}
1212

1313
{% for filename in meta.source_filename %}
14-
<a class="btn btn-default btn-edit" href="https://github.com/ekonstantinidis/django-rest-framework-docs/blob/master/docs/{{ filename }}.md"><i class="fa fa-github"></i> Edit on Github</a>
14+
<a class="btn btn-default btn-edit" href="https://github.com/manosim/django-rest-framework-docs/blob/master/docs/{{ filename }}.md"><i class="fa fa-github"></i> Edit on Github</a>
1515
{% endfor %}
1616
</div>

‎docs/templates.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ To hide the GitHub badge from the page, just override it with an empty block.
4545
{% block footer %}
4646
<div class="footer">
4747
<div class="links">
48-
<a href="http://www.iamemmanouil.com"><i ></i></a>
49-
<a href="http://www.github.com/ekonstantinidis"><i class="fa fa-github"></i></a>
48+
<a href="http://www.manosim.com"><i class="fa fa-link"></i></a>
49+
<a href="http://www.github.com/manosim"><i class="fa fa-github"></i></a>
5050
<a href="http://www.twitter.com/iamemmanouil"><i class="fa fa-twitter"></i></a>
5151
</div>
5252
Copyright © 2016 Emmanouil Konstantinidis.

‎mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ extra_css:
1818
extra_javascript:
1919
- js/index.js
2020

21-
copyright: Copyright © 2015 Emmanouil Konstantinidis.
21+
copyright: Copyright © 2016 Emmanouil Konstantinidis.
2222
google_analytics: ['UA-71505240-1', 'drfdocs.com']
23-
repo_url: https://github.com/ekonstantinidis/django-rest-framework-docs
23+
repo_url: https://github.com/manosim/django-rest-framework-docs

‎rest_framework_docs/templates/rest_framework_docs/base.html

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
<body>
1818
{% block github_badge %}
19-
<a href="https://github.com/ekonstantinidis/drf-docs/" class="github-corner" target="_blank">
19+
<a href="https://github.com/manosim/drf-docs/" class="github-corner" target="_blank">
2020
<svg width="80" height="80" viewBox="0 0 250 250" style="fill:#18bc9c; color:#fff; position: absolute; top: 0; border: 0; right: 0;">
2121
<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
2222
<path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path>
@@ -66,8 +66,8 @@ <h3>Document Web APIs made with <a href="http://www.django-rest-framework.org/"
6666
{% block footer %}
6767
<div class="footer">
6868
<div class="links">
69-
<a href="http://www.iamemmanouil.com"><i class="fa fa-link"></i></a>
70-
<a href="http://www.github.com/ekonstantinidis"><i class="fa fa-github"></i></a>
69+
<a href="http://www.manos.im/"><i class="fa fa-link"></i></a>
70+
<a href="http://www.github.com/manosim"><i class="fa fa-github"></i></a>
7171
<a href="http://www.twitter.com/iamemmanouil"><i class="fa fa-twitter"></i></a>
7272
</div>
7373
Copyright © 2016 Emmanouil Konstantinidis.
@@ -76,6 +76,8 @@ <h3>Document Web APIs made with <a href="http://www.django-rest-framework.org/"
7676
</div>
7777

7878
<!-- Dist.js - Inlcuded Live API, jQuery, Bootstrap -->
79+
{% block script %}
7980
<script type="text/javascript" src="{% static "rest_framework_docs/js/dist.min.js" %}"></script>
81+
{% endblock %}
8082
</body>
8183
</html>

‎rest_framework_docs/templates/rest_framework_docs/home.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{% extends "rest_framework_docs/docs.html" %}
2+
{% load drfdocs_filters %}
23

34
{% block apps_menu %}
45
{% regroup endpoints by name_parent as endpoints_grouped %}
@@ -56,7 +57,7 @@ <h4 class="panel-title title">
5657
<div id="{{ endpoint.path|slugify }}" class="panel-collapse collapse" role="tabpanel">
5758
<div class="panel-body">
5859
{% if endpoint.docstring %}
59-
<p class="lead">{{ endpoint.docstring }}</p>
60+
<p class="lead">{{ endpoint.docstring|markdown }}</p>
6061
{% endif %}
6162

6263
{% if endpoint.errors %}

‎rest_framework_docs/templatetags/__init__.py

Whitespace-only changes.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
from django import template
2+
from django.template.defaultfilters import stringfilter
3+
from rest_framework.utils.formatting import markup_description
4+
5+
6+
register = template.Library()
7+
8+
9+
@register.filter(name='markdown')
10+
@stringfilter
11+
def markdown(value):
12+
return markup_description(value)

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /