add code documentation for websites app

This commit is contained in:
Jan Dittberner 2015-01-27 18:51:04 +01:00
parent 1f485e6b29
commit 5322e00345
5 changed files with 70 additions and 1 deletions

View file

@ -43,3 +43,4 @@ Django app code
code/osusers
code/taskresults
code/userdbs
code/websites

View file

@ -40,7 +40,7 @@
:py:mod:`views <domains.views>`
---------------------------------
-------------------------------
.. automodule:: domains.views
:members:

46
docs/code/websites.rst Normal file
View file

@ -0,0 +1,46 @@
:py:mod:`websites` app
======================
.. automodule:: websites
:py:mod:`admin <websites.admin>`
--------------------------------
.. automodule:: websites.admin
:members:
:py:mod:`apps <websites.apps>`
------------------------------
.. automodule:: websites.apps
:members:
:py:mod:`forms <websites.forms>`
--------------------------------
.. automodule:: websites.forms
:members:
:py:mod:`models <websites.models>`
----------------------------------
.. automodule:: websites.models
:members:
:py:mod:`urls <websites.urls>`
------------------------------
.. automodule:: websites.urls
:members:
:py:mod:`views <websites.views>`
--------------------------------
.. automodule:: websites.views
:members:

View file

@ -0,0 +1,5 @@
"""
This app takes care of websites.
"""
default_app_config = 'websites.apps.WebsitesAppConfig'

View file

@ -0,0 +1,17 @@
"""
This module contains the :py:class:`django.apps.AppConfig` instance for the
:py:mod:`websites` app.
"""
from __future__ import unicode_literals
from django.apps import AppConfig
from django.utils.translation import ugettext_lazy as _
class WebsitesAppConfig(AppConfig):
"""
AppConfig for the :py:mod:`websites` app.
"""
name = 'websites'
verbose_name = _('Websites')