[damned-lies] docs: provide sphinx documentation

From: Claude Paroz <claudep src gnome org>
To: commits-list gnome org
Cc:
Subject: [damned-lies] docs: provide sphinx documentation
Date: Sat, 24 Apr 2021 17:59:02 +0000 (UTC)
commit 531468b061eeae56e1c1ff139cc3882ee321bad3
Author: Guillaume Bernard <associations guillaume-bernard fr>
Date:   Sat Apr 24 19:11:45 2021 +0200

    docs: provide sphinx documentation

 .gitlab-ci.yml                                     | 29 ++++++-
 CONTRIBUTING.md                                    | 21 +++--
 docs/.gitignore                                    |  2 +
 docs/Makefile                                      | 22 +++++
 docs/refresh_doc_files.sh                          | 11 +++
 docs/requirements.txt                              |  3 +
 docs/source/api.package/api.rst                    | 21 +++++
 docs/source/api.package/modules.rst                |  7 ++
 docs/source/common.package/common.rst              | 77 +++++++++++++++++
 docs/source/common.package/common.templatetags.rst | 21 +++++
 docs/source/common.package/modules.rst             |  7 ++
 docs/source/conf.py                                | 96 ++++++++++++++++++++++
 docs/source/feeds.package/feeds.rst                | 13 +++
 docs/source/feeds.package/modules.rst              |  7 ++
 docs/source/index.rst                              | 25 ++++++
 .../languages.package/languages.management.rst     | 16 ++++
 docs/source/languages.package/languages.rst        | 45 ++++++++++
 docs/source/languages.package/modules.rst          |  7 ++
 docs/source/modules.rst                            | 27 ++++++
 docs/source/people.package/modules.rst             |  7 ++
 docs/source/people.package/people.rst              | 53 ++++++++++++
 docs/source/people.package/people.templatetags.rst | 21 +++++
 docs/source/stats.package/modules.rst              |  7 ++
 docs/source/stats.package/stats.management.rst     | 16 ++++
 docs/source/stats.package/stats.rst                | 94 +++++++++++++++++++++
 docs/source/stats.package/stats.templatetags.rst   | 21 +++++
 docs/source/teams.package/modules.rst              |  7 ++
 docs/source/teams.package/teams.rst                | 51 ++++++++++++
 docs/source/vertimus.package/modules.rst           |  7 ++
 docs/source/vertimus.package/vertimus.rst          | 59 +++++++++++++
 30 files changed, 790 insertions(+), 10 deletions(-)
---
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 3320148b..9bf15e08 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -1,10 +1,36 @@
 image: python:latest
 
+stages:
+  - build
+  - test
+
 before_script:
   - apt update -qq && apt install -y -qq libicu-dev python3-icu python3-aeidon gettext intltool itstool 
yelp-tools yelp-xsl gnome-doc-utils
   - pip install -r requirements.txt
 
+pages:
+  stage: build
+  script:
+    - pip3 install -r ./docs/requirements.txt
+    - make -C docs html
+  after_script:
+    - mv docs/build/html/ public/
+  artifacts:
+    paths:
+      - public
+    expire_in: "5 min"
+  rules:
+    # When job is triggered after a push event, run only when code files changed
+    - if: $CI_PIPELINE_SOURCE == "push"
+      changes:
+        - po/*  # po files are committed by l10n itself
+      when: manual
+    # Otherwise, always run job.
+    - when: always
+      allow_failure: false
+
 test:
+  stage: test
   script:
     - pip install coverage
     - python manage.py compile-trans --settings=damnedlies.settings_tests
@@ -30,6 +56,7 @@ test:
       allow_failure: false
 
 linter:
+  stage: test
   script:
     - pip install prospector[with_bandit]
     - prospector
@@ -43,4 +70,4 @@ linter:
       when: manual
     # Otherwise, always run job.
     - when: always
-      allow_failure: true
+      allow_failure: true
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 074bafe4..7c611275 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -5,11 +5,11 @@ This document will help you understand how `damned-lies` works and how to contri
 This document is organized as follows:
 
 - [Introduction](#introduction)
-    - [Responsibilities](#exclamation-responsibilities)
-    - [Your first contribution](#construction_worker-your-first-contribution)
+    - [Responsibilities](#responsibilities)
+    - [Your first contribution](#your-first-contribution)
 - [Installation](#installation)
-    - [Software requirements](#gear-software-requirements)
-    - [Python environment](#snake-python-environment)
+    - [Software requirements](#software-requirements)
+    - [Python environment](#python-environment)
     - [System setup](#system-setup)
     - [Running tests](#running-tests)
     - [Translations](#translations)
@@ -32,7 +32,7 @@ from all the guidelines used by the GNOME community.
 **Note:** if you wish to contribute as a translator in any team, please go to
 the [`damned-lies`](https://l10n.gnome.org) instance instead.
 
-## :exclamation: Responsibilities
+## Responsibilities
 
 - Assume people mean well: when you’re discussing or debating with others, please assume they mean well. 
We’re here to
   cooperate.
@@ -49,7 +49,8 @@ the [`damned-lies`](https://l10n.gnome.org) instance instead.
 - Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See
   the [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/).
 
-## :construction_worker: Your First Contribution
+
+## Your First Contribution
 
 As part of your first contribution, there are a few things and skills you have to acquire or to already have:
 
@@ -61,12 +62,13 @@ As part of your first contribution, there are a few things and skills you have t
 - `damned-lies` is written in **Python** and utilizes the **Django** web framework. It uses a **Bootstrap** 
custom theme
   as its CSS framework.
 
+
 **Note:** If you are not already familiar with Django, we recommend you to go through
 the [Django Tutorial](https://docs.djangoproject.com/en/stable/intro/tutorial01/).
 
 # Installation
 
-## :gear: Software requirements
+## Software requirements
 
 To run properly on any system, `damned-lies` requires some libraries and software to be installed on your 
system.
 
@@ -93,7 +95,8 @@ You can install them on your operating system using the following command line e
   dnf install gettext intltool gnome-doc-utils itstool mariadb-devel libicu-devel python-devel yelp-tools 
@development-tools
   ```
 
-## :snake: Python environment
+
+## Python environment
 
 Once libraries are installed on your OS, the recommended method to run `damned-lies` is to use
 a [virtual environment](https://docs.python.org/en/3/library/venv.html). Python dependencies are listed in
@@ -212,7 +215,7 @@ and run it in the project root’s directory. We provide a custom profile called
 ## Django Coding Style
 
 `damned-lies` is written following
-the [Django Coding 
Style](https://docs.djangoproject.com/en/stable/internals/contributing/writing-code/coding-style/).
+the Django [Coding 
Style](https://docs.djangoproject.com/en/stable/internals/contributing/writing-code/coding-style/).
 Ensure to respect these rules when committing files.
 
 ## Custom rules
diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 00000000..7470254f
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,2 @@
+build
+source/CONTRIBUTING.md
\ No newline at end of file
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 00000000..6d7b462e
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,22 @@
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = damned-lies
+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
+       @cp ./../CONTRIBUTING.md source/CONTRIBUTING.md
+       @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+clean:
+       @rm -f source/CONTRIBUTING.md
+       @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
\ No newline at end of file
diff --git a/docs/refresh_doc_files.sh b/docs/refresh_doc_files.sh
new file mode 100755
index 00000000..6ea118c1
--- /dev/null
+++ b/docs/refresh_doc_files.sh
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+# The purpose of this file is to automatically generate package named rst files
+
+declare -x SPHINX_APIDOC_OPTIONS='members,private-members,show-inheritance'
+
+declare -a DAMNED_LIES_PACKAGES=(api common feeds languages people stats teams vertimus)
+
+for package_name in "${DAMNED_LIES_PACKAGES[@]}"; do
+    sphinx-apidoc -o source/"${package_name}".package ../"${package_name}"
+done
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 00000000..efa74079
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,3 @@
+sphinx
+sphinx_rtd_theme
+recommonmark
diff --git a/docs/source/api.package/api.rst b/docs/source/api.package/api.rst
new file mode 100644
index 00000000..cdcec2e8
--- /dev/null
+++ b/docs/source/api.package/api.rst
@@ -0,0 +1,21 @@
+api package
+===========
+
+Submodules
+----------
+
+api.views module
+----------------
+
+.. automodule:: api.views
+   :members:
+   :private-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: api
+   :members:
+   :private-members:
+   :show-inheritance:
diff --git a/docs/source/api.package/modules.rst b/docs/source/api.package/modules.rst
new file mode 100644
index 00000000..f72fad62
--- /dev/null
+++ b/docs/source/api.package/modules.rst
@@ -0,0 +1,7 @@
+api
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   api
diff --git a/docs/source/common.package/common.rst b/docs/source/common.package/common.rst
new file mode 100644
index 00000000..c6746679
--- /dev/null
+++ b/docs/source/common.package/common.rst
@@ -0,0 +1,77 @@
+common package
+==============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   common.templatetags
+
+Submodules
+----------
+
+common.backends module
+----------------------
+
+.. automodule:: common.backends
+   :members:
+   :private-members:
+   :show-inheritance:
+
+common.context\_processors module
+---------------------------------
+
+.. automodule:: common.context_processors
+   :members:
+   :private-members:
+   :show-inheritance:
+
+common.fields module
+--------------------
+
+.. automodule:: common.fields
+   :members:
+   :private-members:
+   :show-inheritance:
+
+common.middleware module
+------------------------
+
+.. automodule:: common.middleware
+   :members:
+   :private-members:
+   :show-inheritance:
+
+common.models module
+--------------------
+
+.. automodule:: common.models
+   :members:
+   :private-members:
+   :show-inheritance:
+
+common.utils module
+-------------------
+
+.. automodule:: common.utils
+   :members:
+   :private-members:
+   :show-inheritance:
+
+common.views module
+-------------------
+
+.. automodule:: common.views
+   :members:
+   :private-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: common
+   :members:
+   :private-members:
+   :show-inheritance:
diff --git a/docs/source/common.package/common.templatetags.rst 
b/docs/source/common.package/common.templatetags.rst
new file mode 100644
index 00000000..55fb8e9e
--- /dev/null
+++ b/docs/source/common.package/common.templatetags.rst
@@ -0,0 +1,21 @@
+common.templatetags package
+===========================
+
+Submodules
+----------
+
+common.templatetags.list\_to\_columns module
+--------------------------------------------
+
+.. automodule:: common.templatetags.list_to_columns
+   :members:
+   :private-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: common.templatetags
+   :members:
+   :private-members:
+   :show-inheritance:
diff --git a/docs/source/common.package/modules.rst b/docs/source/common.package/modules.rst
new file mode 100644
index 00000000..1f45ca32
--- /dev/null
+++ b/docs/source/common.package/modules.rst
@@ -0,0 +1,7 @@
+common
+======
+
+.. toctree::
+   :maxdepth: 4
+
+   common
diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 00000000..3165543c
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,96 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(1, os.path.abspath('../..'))
+
+import django
+from recommonmark.parser import CommonMarkParser
+
+os.environ['DJANGO_SETTINGS_MODULE'] = 'damnedlies.settings_tests'
+django.setup()
+
+# -- General configuration ------------------------------------------------
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['recommonmark', 'sphinx.ext.autodoc']
+
+# 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_parsers = {'.md': CommonMarkParser,}
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'markdown',
+    '.md': 'markdown',
+}
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'damned-lies'
+# FIXME: is 2006 correct?
+copyright = '2006 - 2021 − The Damned Lies developers'
+author = 'The Damned Lies developers'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+
+# The short X.Y version.
+version = "master"
+# The full version, including alpha/beta/rc tags.
+release = "master"
+
+# 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 = 'en'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns alsso effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+autoclass_content = 'both'
+
+# -- Options for HTML output ----------------------------------------------
+import sphinx_rtd_theme
+
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+html_theme_options = {
+    # Toc options
+    'collapse_navigation': False,
+    'sticky_navigation': True,
+    'navigation_depth': 4,
+    'includehidden': True,
+    'titles_only': True
+}
+
+# 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 = []
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'damned-lies'
diff --git a/docs/source/feeds.package/feeds.rst b/docs/source/feeds.package/feeds.rst
new file mode 100644
index 00000000..e5f80c66
--- /dev/null
+++ b/docs/source/feeds.package/feeds.rst
@@ -0,0 +1,13 @@
+feeds package
+=============
+
+Submodules
+----------
+
+Module contents
+---------------
+
+.. automodule:: feeds
+   :members:
+   :private-members:
+   :show-inheritance:
diff --git a/docs/source/feeds.package/modules.rst b/docs/source/feeds.package/modules.rst
new file mode 100644
index 00000000..702f31dd
--- /dev/null
+++ b/docs/source/feeds.package/modules.rst
@@ -0,0 +1,7 @@
+feeds
+=====
+
+.. toctree::
+   :maxdepth: 4
+
+   feeds
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 00000000..b298954d
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,25 @@
+.. image:: ../damnedlies-logo.svg
+   :target: https://gitlab.gnome.org/Infrastructure/damned-lies
+   :width: 250 px
+   :alt: damned-lies logo
+   :align: center
+
+``damned-lies``
+===============
+
+``damned-lies`` is a `Django <https://djangoproject.com>`_ application and part of the `GNOME 
<https://www.gnome.org>`_ project. It aims at providing an easy way to manage module translations.
+
+.. warning::
+   This documentation is updated against the project **master** branch only.
+
+.. toctree::
+   :maxdepth: 1
+
+   modules
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/source/languages.package/languages.management.rst 
b/docs/source/languages.package/languages.management.rst
new file mode 100644
index 00000000..c22b849a
--- /dev/null
+++ b/docs/source/languages.package/languages.management.rst
@@ -0,0 +1,16 @@
+languages.management package
+============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+Module contents
+---------------
+
+.. automodule:: languages.management
+   :members:
+   :private-members:
+   :show-inheritance:
diff --git a/docs/source/languages.package/languages.rst b/docs/source/languages.package/languages.rst
new file mode 100644
index 00000000..eee9c39b
--- /dev/null
+++ b/docs/source/languages.package/languages.rst
@@ -0,0 +1,45 @@
+languages package
+=================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   languages.management
+
+Submodules
+----------
+
+languages.admin module
+----------------------
+
+.. automodule:: languages.admin
+   :members:
+   :private-members:
+   :show-inheritance:
+
+languages.models module
+-----------------------
+
+.. automodule:: languages.models
+   :members:
+   :private-members:
+   :show-inheritance:
+
+languages.views module
+----------------------
+
+.. automodule:: languages.views
+   :members:
+   :private-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: languages
+   :members:
+   :private-members:
+   :show-inheritance:
diff --git a/docs/source/languages.package/modules.rst b/docs/source/languages.package/modules.rst
new file mode 100644
index 00000000..bd177b37
--- /dev/null
+++ b/docs/source/languages.package/modules.rst
@@ -0,0 +1,7 @@
+languages
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   languages
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
new file mode 100644
index 00000000..3ac0e8b1
--- /dev/null
+++ b/docs/source/modules.rst
@@ -0,0 +1,27 @@
+Contributing
+============
+
+This document guides you for any further contribution.
+
+.. toctree::
+   :maxdepth: 4
+
+   CONTRIBUTING
+
+API Documentation
+=================
+
+API documentation helps you find code documentation.
+
+.. toctree::
+   :maxdepth: 1
+
+   api.package/modules
+   common.package/modules
+   feeds.package/modules
+   languages.package/modules
+   people.package/modules
+   stats.package/modules
+   teams.package/modules
+   vertimus.package/modules
+
diff --git a/docs/source/people.package/modules.rst b/docs/source/people.package/modules.rst
new file mode 100644
index 00000000..a3ed9309
--- /dev/null
+++ b/docs/source/people.package/modules.rst
@@ -0,0 +1,7 @@
+people
+======
+
+.. toctree::
+   :maxdepth: 4
+
+   people
diff --git a/docs/source/people.package/people.rst b/docs/source/people.package/people.rst
new file mode 100644
index 00000000..19f7e93c
--- /dev/null
+++ b/docs/source/people.package/people.rst
@@ -0,0 +1,53 @@
+people package
+==============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   people.templatetags
+
+Submodules
+----------
+
+people.admin module
+-------------------
+
+.. automodule:: people.admin
+   :members:
+   :private-members:
+   :show-inheritance:
+
+people.forms module
+-------------------
+
+.. automodule:: people.forms
+   :members:
+   :private-members:
+   :show-inheritance:
+
+people.models module
+--------------------
+
+.. automodule:: people.models
+   :members:
+   :private-members:
+   :show-inheritance:
+
+people.views module
+-------------------
+
+.. automodule:: people.views
+   :members:
+   :private-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: people
+   :members:
+   :private-members:
+   :show-inheritance:
diff --git a/docs/source/people.package/people.templatetags.rst 
b/docs/source/people.package/people.templatetags.rst
new file mode 100644
index 00000000..1ed40b69
--- /dev/null
+++ b/docs/source/people.package/people.templatetags.rst
@@ -0,0 +1,21 @@
+people.templatetags package
+===========================
+
+Submodules
+----------
+
+people.templatetags.people module
+---------------------------------
+
+.. automodule:: people.templatetags.people
+   :members:
+   :private-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: people.templatetags
+   :members:
+   :private-members:
+   :show-inheritance:
diff --git a/docs/source/stats.package/modules.rst b/docs/source/stats.package/modules.rst
new file mode 100644
index 00000000..2bd2739b
--- /dev/null
+++ b/docs/source/stats.package/modules.rst
@@ -0,0 +1,7 @@
+stats
+=====
+
+.. toctree::
+   :maxdepth: 4
+
+   stats
diff --git a/docs/source/stats.package/stats.management.rst b/docs/source/stats.package/stats.management.rst
new file mode 100644
index 00000000..52c6c157
--- /dev/null
+++ b/docs/source/stats.package/stats.management.rst
@@ -0,0 +1,16 @@
+stats.management package
+========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+Module contents
+---------------
+
+.. automodule:: stats.management
+   :members:
+   :private-members:
+   :show-inheritance:
diff --git a/docs/source/stats.package/stats.rst b/docs/source/stats.package/stats.rst
new file mode 100644
index 00000000..299eda21
--- /dev/null
+++ b/docs/source/stats.package/stats.rst
@@ -0,0 +1,94 @@
+stats package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   stats.management
+   stats.templatetags
+
+Submodules
+----------
+
+stats.admin module
+------------------
+
+.. automodule:: stats.admin
+   :members:
+   :private-members:
+   :show-inheritance:
+
+stats.doap module
+-----------------
+
+.. automodule:: stats.doap
+   :members:
+   :private-members:
+   :show-inheritance:
+
+stats.forms module
+------------------
+
+.. automodule:: stats.forms
+   :members:
+   :private-members:
+   :show-inheritance:
+
+stats.models module
+-------------------
+
+.. automodule:: stats.models
+   :members:
+   :private-members:
+   :show-inheritance:
+
+stats.potdiff module
+--------------------
+
+.. automodule:: stats.potdiff
+   :members:
+   :private-members:
+   :show-inheritance:
+
+stats.repos module
+------------------
+
+.. automodule:: stats.repos
+   :members:
+   :private-members:
+   :show-inheritance:
+
+stats.signals module
+--------------------
+
+.. automodule:: stats.signals
+   :members:
+   :private-members:
+   :show-inheritance:
+
+stats.utils module
+------------------
+
+.. automodule:: stats.utils
+   :members:
+   :private-members:
+   :show-inheritance:
+
+stats.views module
+------------------
+
+.. automodule:: stats.views
+   :members:
+   :private-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: stats
+   :members:
+   :private-members:
+   :show-inheritance:
diff --git a/docs/source/stats.package/stats.templatetags.rst 
b/docs/source/stats.package/stats.templatetags.rst
new file mode 100644
index 00000000..c2f4959e
--- /dev/null
+++ b/docs/source/stats.package/stats.templatetags.rst
@@ -0,0 +1,21 @@
+stats.templatetags package
+==========================
+
+Submodules
+----------
+
+stats.templatetags.stats\_extras module
+---------------------------------------
+
+.. automodule:: stats.templatetags.stats_extras
+   :members:
+   :private-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: stats.templatetags
+   :members:
+   :private-members:
+   :show-inheritance:
diff --git a/docs/source/teams.package/modules.rst b/docs/source/teams.package/modules.rst
new file mode 100644
index 00000000..f80faeec
--- /dev/null
+++ b/docs/source/teams.package/modules.rst
@@ -0,0 +1,7 @@
+teams
+=====
+
+.. toctree::
+   :maxdepth: 4
+
+   teams
diff --git a/docs/source/teams.package/teams.rst b/docs/source/teams.package/teams.rst
new file mode 100644
index 00000000..bbb9670a
--- /dev/null
+++ b/docs/source/teams.package/teams.rst
@@ -0,0 +1,51 @@
+teams package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+Submodules
+----------
+
+teams.admin module
+------------------
+
+.. automodule:: teams.admin
+   :members:
+   :private-members:
+   :show-inheritance:
+
+teams.forms module
+------------------
+
+.. automodule:: teams.forms
+   :members:
+   :private-members:
+   :show-inheritance:
+
+teams.models module
+-------------------
+
+.. automodule:: teams.models
+   :members:
+   :private-members:
+   :show-inheritance:
+
+teams.views module
+------------------
+
+.. automodule:: teams.views
+   :members:
+   :private-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: teams
+   :members:
+   :private-members:
+   :show-inheritance:
diff --git a/docs/source/vertimus.package/modules.rst b/docs/source/vertimus.package/modules.rst
new file mode 100644
index 00000000..616c18f7
--- /dev/null
+++ b/docs/source/vertimus.package/modules.rst
@@ -0,0 +1,7 @@
+vertimus
+========
+
+.. toctree::
+   :maxdepth: 4
+
+   vertimus
diff --git a/docs/source/vertimus.package/vertimus.rst b/docs/source/vertimus.package/vertimus.rst
new file mode 100644
index 00000000..d642f38d
--- /dev/null
+++ b/docs/source/vertimus.package/vertimus.rst
@@ -0,0 +1,59 @@
+vertimus package
+================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+Submodules
+----------
+
+vertimus.admin module
+---------------------
+
+.. automodule:: vertimus.admin
+   :members:
+   :private-members:
+   :show-inheritance:
+
+vertimus.feeds module
+---------------------
+
+.. automodule:: vertimus.feeds
+   :members:
+   :private-members:
+   :show-inheritance:
+
+vertimus.forms module
+---------------------
+
+.. automodule:: vertimus.forms
+   :members:
+   :private-members:
+   :show-inheritance:
+
+vertimus.models module
+----------------------
+
+.. automodule:: vertimus.models
+   :members:
+   :private-members:
+   :show-inheritance:
+
+vertimus.views module
+---------------------
+
+.. automodule:: vertimus.views
+   :members:
+   :private-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: vertimus
+   :members:
+   :private-members:
+   :show-inheritance:
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]