Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yakky committed May 1, 2014
1 parent 6a3b62e commit 8d5493c
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 9 deletions.
2 changes: 1 addition & 1 deletion djangocms_installer/__init__.py
Expand Up @@ -2,4 +2,4 @@
# -*- coding: utf-8 -*-
__author__ = 'Iacopo Spalletti'
__email__ = 'i.spalletti@nephila.it'
__version__ = '0.4.2'
__version__ = '0.5.0.dev1'
2 changes: 1 addition & 1 deletion docs/conf.py
Expand Up @@ -132,7 +132,7 @@
# 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']
#html_static_path = ['_static']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
Expand Down
11 changes: 8 additions & 3 deletions docs/faq.rst
@@ -1,5 +1,5 @@
djangocms-installer FAQ
=======================
FAQ
===

#. I need to use version **foo** of package *blargh*, while the installer
want to use version **baz**, how can I solve this?
Expand All @@ -22,6 +22,11 @@ djangocms-installer FAQ
errors lie somewhere else. In this case, please open an issue on github
`project`_, or ask in the #django-cms IRC channel.

#. How can I configure the database to use?

**djangocms-installer** uses `dj-database-url`_ to get database
configuration parameters; refer to this package for more details.

.. _project: https://github.com/nephila/djangocms-installer/issues

.. _dj-database-url: https://github.com/kennethreitz/dj-database-url
.. _project: https://github.com/nephila/djangocms-installer/issues
12 changes: 8 additions & 4 deletions docs/reference.rst
@@ -1,7 +1,7 @@
.. _arguments:

djangocms-installer arguments
==========================
Arguments reference
===================

Required arguments
------------------
Expand All @@ -17,7 +17,8 @@ Wizard arguments

The following arguments can be overridden in :ref:`wizard_mode`

* ``--db``, ``-d``: Database configuration (in URL format); default: ``sqlite://localhost/project.db``
* ``--db``, ``-d``: Database configuration (in URL format); use `dj-database-url`_
syntax; default: ``sqlite://localhost/project.db``
* ``--i18n``, ``-i``: Activate Django I18N / L10N setting; choices: ``yes|no``, default: ``yes``
* ``--use-tz``, ``-z``: Activate Django timezone support; choices: ``yes|no``, default: ``yes``
* ``--timezone``, ``-t``: Optional default time zone, default: ``America/Chicago``
Expand All @@ -29,7 +30,7 @@ The following arguments can be overridden in :ref:`wizard_mode`
* ``--bootstrap``, ``-v``: Use Twitter Bootstrap as theme, choices: ``yes|no``, default: ``no``
* ``--starting-page``, ``-v``: Load a starting page with examples after installation, choices: ``yes|no``, default: ``no``

.. note:: the ``stable`` keyword is expanded to the following Django version::
.. note:: the ``stable`` keyword is expanded to the following Django version:

* if django CMS version is 3.0 or develop: **stable** is expanded to Django==1.6;
* if django CMS version is 2.4: **stable** is expanded to Django==1.5;
Expand All @@ -56,3 +57,6 @@ advanced usage:
* ``--list-plugins``, ``-P``: List plugins that's going to be installed and
configured for the project; this will not alter the virtualenv or create the
project;


.. _dj-database-url: https://github.com/kennethreitz/dj-database-url

0 comments on commit 8d5493c

Please sign in to comment.