writing docs with rst and sphinx

eshaan7 · Oct 25, 2020 · 5d788d9 · 5d788d9
1 parent ca3cc08
commit 5d788d9
Show file tree

Hide file tree

Showing 27 changed files with 65 additions and 483 deletions.
diff --git a/.flake8 b/.flake8
@@ -4,3 +4,4 @@ exclude =
     *migrations*,
     *venv*
     virtualenv
+    docs
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,8 @@ __pycache__/
 *.py[cod]
 
 venv/
+.vscode/
+build/
 
 # C extensions
 *.so

diff --git a/.vscode/settings.json b/.vscode/settings.json
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/README.md b/README.md
@@ -16,14 +16,13 @@ Durin authentication is token based, similar to the `TokenAuthentication`
 built in to DRF. However, it adds some extra sauce:
 
 - Durin allows **multiple tokens per user**. But only one token each user per API client.
-- Each user token is associated with an API Client. These API Clients are configurable via Django's Admin Interface.
+- 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.
 - All Durin **tokens have an expiration time**. This expiration time can be different per API client.
-- Durin provides an option for a logged in user to remove *all*
-    tokens that the server has - forcing him/her to re-authenticate for all API clients.
+- 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.
 - Durin **tokens can be renewed** to get a fresh expiry.
 - Durin provides a `CachedTokenAuthentication` backend as well which uses memoization for faster look ups.
 
-More information can be found in the [Documentation](https://django-rest-durin.readthedocs.io/).
+More information can be found in the [Documentation](https://django-rest-durin.readthedocs.io/en/latest/installation.html).
 
 ## Django Compatibility Matrix
 
@@ -47,8 +46,4 @@ This project is published with the [MIT License](LICENSE). See [https://chooseal
 
 ## Credits
 
-<<<<<<< HEAD
-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.
-=======
-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.
->>>>>>> docs
+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.
diff --git a/docs/auth.md b/docs/auth.md
diff --git a/docs/changelog.md b/docs/changelog.md
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/installation.md b/docs/installation.md
diff --git a/docs/requirements.docs.txt b/docs/requirements.docs.txt
@@ -1,4 +1,5 @@
-../requirements.dev.txt
+-r ../requirements.dev.txt
+django>=2.2
 commonmark==0.9.1
 docutils==0.16
 Sphinx==3.2.1

diff --git a/docs/settings.md b/docs/settings.md
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -0,0 +1,7 @@
+Changelog
+============
+
+`v0.1.0 <https://github.com/eshaan7/django-rest-durin/releases/tag/v0.1.0>`__
+--------------------------------------------------------------------------------
+
+- Initial release