Skip to content

Commit 5d788d9

Browse files
committed
writing docs with rst and sphinx
1 parent ca3cc08 commit 5d788d9

27 files changed

+65
-483
lines changed

.flake8

+1
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ exclude =
44
*migrations*,
55
*venv*
66
virtualenv
7+
docs

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ __pycache__/
33
*.py[cod]
44

55
venv/
6+
.vscode/
7+
build/
68

79
# C extensions
810
*.so

.vscode/settings.json

-7
This file was deleted.

CHANGELOG.md

-2
This file was deleted.

MANIFEST.in

-4
This file was deleted.

README.md

+4-9
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,13 @@ Durin authentication is token based, similar to the `TokenAuthentication`
1616
built in to DRF. However, it adds some extra sauce:
1717

1818
- Durin allows **multiple tokens per user**. But only one token each user per API client.
19-
- Each user token is associated with an API Client. These API Clients are configurable via Django's Admin Interface.
19+
- Each user token is associated with an API Client. These API Clients are configurable via Django's Admin Interface. This allows restricting certain `APIViews` to only specific clients or vice-a-versa.
2020
- All Durin **tokens have an expiration time**. This expiration time can be different per API client.
21-
- Durin provides an option for a logged in user to remove *all*
22-
tokens that the server has - forcing him/her to re-authenticate for all API clients.
21+
- Durin provides an option for a logged in user to **remove all tokens** that the server has - forcing them to re-authenticate for all API clients.
2322
- Durin **tokens can be renewed** to get a fresh expiry.
2423
- Durin provides a `CachedTokenAuthentication` backend as well which uses memoization for faster look ups.
2524

26-
More information can be found in the [Documentation](https://django-rest-durin.readthedocs.io/).
25+
More information can be found in the [Documentation](https://django-rest-durin.readthedocs.io/en/latest/installation.html).
2726

2827
## Django Compatibility Matrix
2928

@@ -47,8 +46,4 @@ This project is published with the [MIT License](LICENSE). See [https://chooseal
4746

4847
## Credits
4948

50-
<<<<<<< HEAD
51-
Durin is inpired by the [django-rest-knox](https://github.com/James1345/django-rest-knox) and [django-rest-multitokenauth](https://github.com/anexia-it/django-rest-multitokenauth) libraries and includes some learnings and code from both.
52-
=======
53-
Durin is inpired by the [django-rest-knox](https://github.com/James1345/django-rest-knox) and [django-rest-multitokenauth](https://github.com/anexia-it/django-rest-multitokenauth) libraries and includes some learnings, docs and code from both.
54-
>>>>>>> docs
49+
Durin is inpired by the [django-rest-knox](https://github.com/James1345/django-rest-knox) and [django-rest-multitokenauth](https://github.com/anexia-it/django-rest-multitokenauth) libraries and adopts some learnings, docs and code from both.

docs/auth.md

-108
This file was deleted.

docs/changelog.md

-1
This file was deleted.

docs/index.md

-31
This file was deleted.

docs/installation.md

-66
This file was deleted.

docs/requirements.docs.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
../requirements.dev.txt
1+
-r ../requirements.dev.txt
2+
django>=2.2
23
commonmark==0.9.1
34
docutils==0.16
45
Sphinx==3.2.1

docs/settings.md

-105
This file was deleted.

docs/source/changelog.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Changelog
2+
============
3+
4+
`v0.1.0 <https://github.com/eshaan7/django-rest-durin/releases/tag/v0.1.0>`__
5+
--------------------------------------------------------------------------------
6+
7+
- Initial release

0 commit comments

Comments
 (0)