Skip to content

Commit 3549016

Browse files
committed
cleanup + docs for application views
1 parent ce04a0b commit 3549016

File tree

4 files changed

+48
-2
lines changed

4 files changed

+48
-2
lines changed

docs/index.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
contain the root `toctree` directive.
55
66
Welcome to Django OAuth Toolkit Documentation
7-
====================
7+
=============================================
88

99
Django OAuth Toolkit can help you providing out of the box all the endpoints, data and logic needed to add OAuth2
1010
capabilities to your Django projects. Django OAuth Toolkit makes extensive use of the excellent
@@ -25,7 +25,7 @@ Requirements
2525
* Django 1.4, 1.5, 1.6b3
2626

2727
Index
28-
========
28+
=====
2929

3030
.. toctree::
3131
:maxdepth: 2
@@ -34,6 +34,8 @@ Index
3434
tutorial/tutorial
3535
rest-framework/rest-framework
3636
views/views
37+
views/details
38+
models
3739
advanced_topics
3840
settings
3941
glossary

docs/views/application.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Application Views
2+
=================
3+
4+
A set of views is provided to let users handle application instances without accessing Django Admin
5+
Site.
6+
7+
.. automodule:: oauth2_provider.views.application
8+
:members:

docs/views/details.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Views code and details
2+
======================
3+
4+
5+
Generic
6+
-------
7+
Generic views are intended to use in a "batteries included" fashion to protect own views with OAuth2 authentication and
8+
Scopes handling.
9+
10+
.. automodule:: oauth2_provider.views.generic
11+
:members:
12+
13+
Mixins
14+
------
15+
These views are mainly for internal use, but advanced users may use them as basic components to customize OAuth2 logic
16+
inside their Django applications.
17+
18+
.. automodule:: oauth2_provider.views.mixins
19+
:members:
20+
21+
Base
22+
----
23+
Views needed to implement the main OAuth2 authorization flows supported by Django OAuth Toolkit.
24+
25+
.. automodule:: oauth2_provider.views.base
26+
:members:
27+
28+
Application
29+
-----------
30+
Views providing a CRUD for applications outside the Django Admin.
31+
32+
.. automodule:: oauth2_provider.views.application
33+
:members:

docs/views/views.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
Using the views
22
===============
33

4+
Django OAuth Toolkit provides a set of pre-defined views for different purposes:
5+
46
.. toctree::
57
:maxdepth: 2
68

79
function_based
810
class_based
11+
application

0 commit comments

Comments
 (0)