Merge branch 'update-docs' into 'master'

Update docs

See merge request !642

docs/events.api.rst

@@ -9,6 +9,14 @@ events.api package
 Submodules
 ----------
 
+events.api.permissions module
+-----------------------------
+
+.. automodule:: events.api.permissions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 events.api.serializers module
 -----------------------------
 

docs/events.rst

@@ -24,6 +24,14 @@ events.admin module
     :undoc-members:
     :show-inheritance:
 
+events.admin_views module
+-------------------------
+
+.. automodule:: events.admin_views
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 events.apps module
 ------------------
 
@@ -32,6 +40,30 @@ events.apps module
     :undoc-members:
     :show-inheritance:
 
+events.decorators module
+------------------------
+
+.. automodule:: events.decorators
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+events.emails module
+--------------------
+
+.. automodule:: events.emails
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+events.exceptions module
+------------------------
+
+.. automodule:: events.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 events.feeds module
 -------------------
 
@@ -56,6 +88,14 @@ events.models module
     :undoc-members:
     :show-inheritance:
 
+events.services module
+----------------------
+
+.. automodule:: events.services
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 events.sitemaps module
 ----------------------
 

docs/generate-apidocs.sh

@@ -4,4 +4,4 @@ if [ ! -f "./index.rst" ]; then
     exit 1
 fi
 
-sphinx-apidoc -M -f -o docs ../website ../website/*/migrations ../website/*/tests* ../website/manage.py
+sphinx-apidoc -M -f -o . ../website ../website/*/migrations ../website/*/tests* ../website/manage.py

docs/mailinglists.api.rst

+mailinglists.api package
+========================
+
+.. automodule:: mailinglists.api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+mailinglists.api.permissions module
+-----------------------------------
+
+.. automodule:: mailinglists.api.permissions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+mailinglists.api.serializers module
+-----------------------------------
+
+.. automodule:: mailinglists.api.serializers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+mailinglists.api.urls module
+----------------------------
+
+.. automodule:: mailinglists.api.urls
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+mailinglists.api.viewsets module
+--------------------------------
+
+.. automodule:: mailinglists.api.viewsets
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+

docs/mailinglists.rst

@@ -6,6 +6,13 @@ mailinglists package
     :undoc-members:
     :show-inheritance:
 
+Subpackages
+-----------
+
+.. toctree::
+
+    mailinglists.api
+
 Submodules
 ----------
 
@@ -32,3 +39,13 @@ mailinglists.models module
     :members:
     :undoc-members:
     :show-inheritance:
+
+mailinglists.services module
+----------------------------
+
+.. automodule:: mailinglists.services
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+

docs/members.rst

@@ -32,6 +32,14 @@ members.apps module
     :undoc-members:
     :show-inheritance:
 
+members.emails module
+---------------------
+
+.. automodule:: members.emails
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 members.forms module
 --------------------
 
@@ -40,6 +48,14 @@ members.forms module
     :undoc-members:
     :show-inheritance:
 
+members.middleware module
+-------------------------
+
+.. automodule:: members.middleware
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 members.models module
 ---------------------
 
@@ -48,6 +64,14 @@ members.models module
     :undoc-members:
     :show-inheritance:
 
+members.services module
+-----------------------
+
+.. automodule:: members.services
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 members.sitemaps module
 -----------------------
 

docs/modules.rst

@@ -16,6 +16,7 @@ website
    partners
    photos
    pizzas
+   pushnotifications
    registrations
    thabloid
    thaliawebsite

docs/partners.rst

@@ -33,6 +33,14 @@ partners.context_processors module
     :undoc-members:
     :show-inheritance:
 
+partners.emails module
+----------------------
+
+.. automodule:: partners.emails
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 partners.models module
 ----------------------
 

docs/pizzas.api.rst

+pizzas.api package
+==================
+
+.. automodule:: pizzas.api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+pizzas.api.serializers module
+-----------------------------
+
+.. automodule:: pizzas.api.serializers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pizzas.api.urls module
+----------------------
+
+.. automodule:: pizzas.api.urls
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pizzas.api.viewsets module
+--------------------------
+
+.. automodule:: pizzas.api.viewsets
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+

docs/pizzas.rst

@@ -6,6 +6,13 @@ pizzas package
     :undoc-members:
     :show-inheritance:
 
+Subpackages
+-----------
+
+.. toctree::
+
+    pizzas.api
+
 Submodules
 ----------
 

docs/pushnotifications.api.rst

+pushnotifications.api package
+=============================
+
+.. automodule:: pushnotifications.api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+pushnotifications.api.permissions module
+----------------------------------------
+
+.. automodule:: pushnotifications.api.permissions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pushnotifications.api.serializers module
+----------------------------------------
+
+.. automodule:: pushnotifications.api.serializers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pushnotifications.api.urls module
+---------------------------------
+
+.. automodule:: pushnotifications.api.urls
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pushnotifications.api.viewsets module
+-------------------------------------
+
+.. automodule:: pushnotifications.api.viewsets
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+

docs/pushnotifications.rst

+pushnotifications package
+=========================
+
+.. automodule:: pushnotifications
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    pushnotifications.api
+
+Submodules
+----------
+
+pushnotifications.admin module
+------------------------------
+
+.. automodule:: pushnotifications.admin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pushnotifications.apps module
+-----------------------------
+
+.. automodule:: pushnotifications.apps
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pushnotifications.models module
+-------------------------------
+
+.. automodule:: pushnotifications.models
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pushnotifications.urls module
+-----------------------------
+
+.. automodule:: pushnotifications.urls
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pushnotifications.views module
+------------------------------
+
+.. automodule:: pushnotifications.views
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+

docs/registrations.rst

@@ -6,55 +6,78 @@ registrations package
     :undoc-members:
     :show-inheritance:
 
+Subpackages
+-----------
+
+.. toctree::
+
+    registrations.templatetags
+
 Submodules
 ----------
 
-registrations\.admin module
----------------------------
+registrations.admin module
+--------------------------
 
 .. automodule:: registrations.admin
     :members:
     :undoc-members:
     :show-inheritance:
 
-registrations\.apps module
---------------------------
+registrations.apps module
+-------------------------
 
 .. automodule:: registrations.apps
     :members:
     :undoc-members:
     :show-inheritance:
 
-registrations\.emails module
-----------------------------
+registrations.emails module
+---------------------------
 
 .. automodule:: registrations.emails
     :members:
     :undoc-members:
     :show-inheritance:
 
-registrations\.models module
-----------------------------
+registrations.forms module
+--------------------------
+
+.. automodule:: registrations.forms
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+registrations.models module
+---------------------------
 
 .. automodule:: registrations.models
     :members:
     :undoc-members:
     :show-inheritance:
 
-registrations\.services module
-------------------------------
+registrations.services module
+-----------------------------
 
 .. automodule:: registrations.services
     :members:
     :undoc-members:
     :show-inheritance:
 
-registrations\.urls module
---------------------------
+registrations.urls module
+-------------------------
 
 .. automodule:: registrations.urls
     :members:
     :undoc-members:
     :show-inheritance:
 
+registrations.views module
+--------------------------
+
+.. automodule:: registrations.views
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 

docs/registrations.templatetags.rst

+registrations.templatetags package
+==================================
+
+.. automodule:: registrations.templatetags
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+registrations.templatetags.form_field module
+--------------------------------------------
+
+.. automodule:: registrations.templatetags.form_field
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+

docs/thaliawebsite.templatetags.rst

@@ -9,6 +9,14 @@ thaliawebsite.templatetags package
 Submodules
 ----------
 
+thaliawebsite.templatetags.baseurl module
+-----------------------------------------
+
+.. automodule:: thaliawebsite.templatetags.baseurl
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 thaliawebsite.templatetags.bleach_tags module
 ---------------------------------------------
 
@@ -33,4 +41,12 @@ thaliawebsite.templatetags.menu module
     :undoc-members:
     :show-inheritance:
 
+thaliawebsite.templatetags.pick_header_image module
+---------------------------------------------------
+
+.. automodule:: thaliawebsite.templatetags.pick_header_image
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 

docs/utils.rst

@@ -9,6 +9,14 @@ utils package
 Submodules
 ----------
 
+utils.exception_filter module
+-----------------------------
+
+.. automodule:: utils.exception_filter
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 utils.snippets module
 ---------------------