writing docs

eshaan7 · Oct 25, 2020 · 0057049 · 0057049
1 parent e536588
commit 0057049
Show file tree

Hide file tree

Showing 34 changed files with 801 additions and 511 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -2,5 +2,6 @@
     "python.formatting.provider": "black",
     "python.linting.pylintEnabled": false,
     "python.linting.flake8Enabled": true,
-    "python.linting.enabled": true
+    "python.linting.enabled": true,
+    "restructuredtext.confPath": "${workspaceFolder}/venv/lib/python3.8/site-packages/django/urls"
 }
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -1,3 +1,4 @@
 - James McMahon
 - Eshaan Bansal
+- Shabda Raaj
 - Matteo Lodi
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# django-rest-durin
+# Django-Rest-Durin
 
 [![django-rest-durin on pypi](https://img.shields.io/pypi/v/django-rest-durin)](https://pypi.org/project/django-rest-durin/)
 [![Build Status](https://travis-ci.com/Eshaan7/django-rest-durin.svg?branch=main)](https://travis-ci.com/Eshaan7/django-rest-durin)
@@ -16,29 +16,14 @@ 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.
-
 - 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 tokens can be renewed to get a fresh expiry.
+- Durin provides a `CachedTokenAuthentication` backend as well which uses memoization for faster look ups.
 
-- Durin provides a [Cached Token Authentication](#cache-backend) backend as well.
-
-More information can be found in the [Documentation]()
-
-## Cache Backend
-
-If you want to use a cache for the session store, you can install [django-memoize](https://pythonhosted.org/django-memoize/) and add `'memoize'` to `INSTALLED_APPS`.
-
-Then you need to use ``CachedTokenAuthentication`` instead of ``TokenAuthentication``.
-
-```bash
-pip install django-memoize
-```
+More information can be found in the [Documentation](https://django-rest-durin.readthedocs.io/).
 
 ## Django Compatibility Matrix
 
@@ -62,4 +47,4 @@ This project is published with the [MIT License](LICENSE). See [https://chooseal
 
 ## Credits
 
-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.
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
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/make.bat b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/requirements.docs.txt b/docs/requirements.docs.txt
@@ -0,0 +1,11 @@
+../requirements.dev.txt
+commonmark==0.9.1
+docutils==0.16
+Sphinx==3.2.1
+sphinx-rtd-theme
+sphinxcontrib-applehelp==1.0.2
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-htmlhelp==1.0.3
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.4
diff --git a/docs/serve_docs.sh b/docs/serve_docs.sh
@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+export DJANGO_SETTINGS_MODULE="example_project.settings"
+make html
+cd build/html && python3 -m http.server 6969 && cd ../../