Initial documentation

README.md

@@ -84,7 +84,7 @@ Below is sample, minimal config you can provide in your django settings which wi
 REST_REGISTRATION = {
     'REGISTER_VERIFICATION_ENABLED': False,
 
-    'RESET_PASSWORD_VERIFICATION_URL': 'https://frontend-url/reset-password/',
+    'RESET_PASSWORD_VERIFICATION_URL': 'https://frontend-host/reset-password/',
 
     'REGISTER_EMAIL_VERIFICATION_ENABLED': False,
 
@@ -96,9 +96,9 @@ However, the preferred base configuration would be:
 
 ```python
 REST_REGISTRATION = {
-    'REGISTER_VERIFICATION_URL': 'https://frontend-url/verify-user/',
-    'RESET_PASSWORD_VERIFICATION_URL': 'https://frontend-url/reset-password/',
-    'REGISTER_EMAIL_VERIFICATION_URL': 'https://frontend-url/verify-email/',
+    'REGISTER_VERIFICATION_URL': 'https://frontend-host/verify-user/',
+    'RESET_PASSWORD_VERIFICATION_URL': 'https://frontend-host/reset-password/',
+    'REGISTER_EMAIL_VERIFICATION_URL': 'https://frontend-host/verify-email/',
 
     'VERIFICATION_FROM_EMAIL': 'no-reply@example.com',
 }
@@ -112,15 +112,15 @@ them to corresponding REST API views via HTTP POST request.
 Let's explain it by example:
 
 we're assuming that the `django-rest-registration` views are served at
-https://backend-url/api/v1/accounts/.
-The frontend endpoint https://frontend-url/verify-email/ would receive
+https://backend-host/api/v1/accounts/.
+The frontend endpoint https://frontend-host/verify-email/ would receive
 following GET parameters:
 * `user_id`
 * `email`
 * `timestamp`
 * `signature`
 
-and then it should perform AJAX request to https://backend-url/api/v1/accounts/verify-email/
+and then it should perform AJAX request to https://backend-host/api/v1/accounts/verify-email/
 via HTTP POST with following JSON payload:
 
 ```javascript

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+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)

docs/conf.py

@@ -0,0 +1,226 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+import datetime
+import os.path
+import re
+import sys
+
+# -- Path setup --------------------------------------------------------------
+DOCS_DIR = os.path.abspath(os.path.dirname(__file__))
+ROOT_DIR = os.path.dirname(DOCS_DIR)
+
+sys.path.append(ROOT_DIR)
+
+from rest_registration.settings_fields import (  # isort:skip
+    SETTINGS_FIELDS,
+    SETTINGS_FIELDS_GROUPS_MAP,
+)  # noqa: E402
+
+# -- Project information -----------------------------------------------------
+
+
+def read_contents(local_filepath):
+    with open(os.path.join(ROOT_DIR, local_filepath)) as f:
+        return f.read()
+
+
+def get_version(package):
+    '''
+    Return package version as listed in `__version__` in `init.py`.
+    '''
+    init_py = read_contents(os.path.join(package, '__init__.py'))
+    return re.search("__version__ = ['\"]([^'\"]+)['\"]", init_py).group(1)
+
+
+project = 'Django REST Registration'
+docs_title = '{project} documentation'.format(project=project)
+author = 'Andrzej Pragacz'
+now = datetime.datetime.now()
+copyright = '{now.year}, {author}'.format(author=author, now=now)
+version = get_version('rest_registration')
+release = version
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinxcontrib.jinja',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'django-rest-registration-doc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (
+        master_doc,
+        'django-rest-registration.tex',
+        docs_title,
+        author,
+        'manual',
+    ),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (
+        master_doc,
+        project,
+        docs_title,
+        [author],
+        1,
+    ),
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        project,
+        docs_title,
+        author,
+        project,
+        'User registration REST API, based on django-rest-framework',
+        'Miscellaneous',
+    ),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+jinja_base = DOCS_DIR
+jinja_contexts = {
+    'detailed_configuration__all_settings': {
+        'settings_fields': SETTINGS_FIELDS,
+    }
+}
+
+for group_name, settings_fields in SETTINGS_FIELDS_GROUPS_MAP.items():
+    ctx_key = 'detailed_configuration__{group_name}'.format(
+        group_name=group_name)
+    jinja_contexts[ctx_key] = {
+        'settings_fields': settings_fields,
+    }

docs/detailed_configuration/all_settings.rst

@@ -0,0 +1,9 @@
+List of all settings
+====================
+
+Below are listed all possible Django REST Registration settings.
+You should add them as keys (with values)
+to your ``settings.REST_REGISTRATION`` dict.
+
+.. jinja:: detailed_configuration__all_settings
+   :file: detailed_configuration/settings_fields.j2

docs/detailed_configuration/change_password.rst

@@ -0,0 +1,15 @@
+Changing password
+=================
+
+API Views
+---------
+
+List of settings
+----------------
+
+These settings can be used to configure changing password workflow.
+You should add them as keys (with values)
+to your ``settings.REST_REGISTRATION`` dict.
+
+.. jinja:: detailed_configuration__change_password
+   :file: detailed_configuration/settings_fields.j2

docs/detailed_configuration/global_verification.rst

@@ -0,0 +1,13 @@
+Global verification
+===================
+
+List of settings
+----------------
+
+These settings can be used to configure how verification should work
+(for things like registration, password reset, email change).
+You should add them as keys (with values)
+to your ``settings.REST_REGISTRATION`` dict.
+
+.. jinja:: detailed_configuration__global_verification
+   :file: detailed_configuration/settings_fields.j2

docs/detailed_configuration/html_email.rst

@@ -0,0 +1,36 @@
+HTML e-mail configuration
+=========================
+
+You can send the verification emails as HTML, by specifying
+``html_body`` instead of ``body``; for example:
+
+.. code:: python
+
+    REST_REGISTRATION = {
+        ...
+
+        'REGISTER_VERIFICATION_EMAIL_TEMPLATES': {
+            'subject':  'rest_registration/register/subject.txt',
+            'html_body':  'rest_registration/register/body.html',
+        },
+
+        ...
+    }
+
+This will automatically create fallback plain text message from the
+HTML. If you want to have custom fallback message you can also provide
+separate template for text:
+
+.. code:: python
+
+    REST_REGISTRATION = {
+        ...
+
+        'REGISTER_VERIFICATION_EMAIL_TEMPLATES': {
+            'subject':  'rest_registration/register/subject.txt',
+            'text_body':  'rest_registration/register/body.txt',
+            'html_body':  'rest_registration/register/body.html',
+        },
+
+        ...
+    }

docs/detailed_configuration/index.rst

@@ -0,0 +1,16 @@
+Detailed configuration
+======================
+
+.. toctree::
+   :maxdepth: 2
+
+   user
+   global_verification
+   register
+   login
+   profile
+   reset_password
+   change_password
+   register_email
+   html_email
+   all_settings

docs/detailed_configuration/login.rst

@@ -0,0 +1,15 @@
+Login
+=====
+
+API Views
+---------
+
+List of settings
+----------------
+
+These settings can be used to configure login views.
+You should add them as keys (with values)
+to your ``settings.REST_REGISTRATION`` dict.
+
+.. jinja:: detailed_configuration__login
+   :file: detailed_configuration/settings_fields.j2