Skip to content

Commit 67915c2

Browse files
author
Emmanouil Konstantinidis
committed
Mention website/docs in README.md
1 parent 7b83c35 commit 67915c2

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@ Document Web APIs made with Django Rest Framework.
1111
- Django Rest Framework (3+)
1212

1313

14+
### Documentation - Table of contents
15+
16+
- [Installation](http://drfdocs.com/docs/installation/)
17+
- [Settings](http://drfdocs.com/docs/settings/)
18+
- [Extending the template](http://drfdocs.com/docs/templates/)
19+
- [Contributing & Development](http://drfdocs.com/docs/contributing/)
20+
- [Changelog](http://drfdocs.com/docs/changelog/)
21+
22+
1423
### Development & Demo Project
1524
If you are looking to develop this package with one of your own django projects:
1625

@@ -21,6 +30,8 @@ If you are looking to develop this package with one of your own django projects:
2130
If you want to use the demo app to work on this package:
2231
Included in this repo you can find the demo project(at `/demo`). It is a project with *Django* & *Django Rest Framework* that will allow you to work with this project. For more information on how you can set it up please check the [README.md](demo/README.md) of the demo project.
2332

33+
For more information visit [the docs](http://drfdocs.com/docs/contributing/).
34+
2435
### Installation
2536

2637
Install using pip:
@@ -43,6 +54,7 @@ Finally include the `rest_framework_docs` urls in your `urls.py`:
4354

4455

4556
### Settings
57+
You can find detailed information about the package's settings at [the docs](http://drfdocs.com/docs/settings/).
4658

4759
REST_FRAMEWORK_DOCS = {
4860
'HIDDEN': True # Default: False

0 commit comments

Comments
 (0)