Skip to content

Commit

Permalink
Document management commands
Browse files Browse the repository at this point in the history
Fixes #1
  • Loading branch information
paltman committed Jan 2, 2013
1 parent 66cdccc commit e2d7dd3
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/conf.py
Expand Up @@ -41,16 +41,16 @@


# General information about the project. # General information about the project.
project = u'kaleo' project = u'kaleo'
copyright = u'2011, Eldarion' copyright = u'2013, Eldarion'


# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '0.4' version = '0.5'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '0.4' release = '0.5'


# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Expand Up @@ -22,4 +22,5 @@ Contents
settings settings
templates templates
signals signals
management
changelog changelog
19 changes: 19 additions & 0 deletions docs/management.rst
@@ -0,0 +1,19 @@
.. _management:

Management Commands
===================

add_invites
-----------

Adds invites to all users with 0 invites remaining.

manage.py add_invites 10 # Adds 10 new invites to all users with 0 invites remaining


topoff_invites
--------------

Makes sure all users have a certain number of invites.

manage.py topoff_invites 10 # Makes sure that all users have exactly 10 invites

This comment has been minimized.

Copy link
@jtauber

jtauber Jan 2, 2013

Member

should this be "at least"? if a user has 15 invites and you run topoff_invites 10 won't they still have 15?

0 comments on commit e2d7dd3

Please sign in to comment.