Docs (#312)

* Added initial documentation, closes #285
* Update contributing.rst #287
* Updated titles in documentation, generation of docs was throwing errors
* Updated settings styling, renamed to installation as it should cover this as well

README.rst

@@ -10,6 +10,10 @@ django-konfera
 .. image:: https://codecov.io/gh/pyconsk/django-konfera/branch/master/graph/badge.svg
     :target: https://codecov.io/gh/pyconsk/django-konfera
 
+.. image:: https://readthedocs.org/projects/django-konfera/badge/
+    :target: https://django-konfera.readthedocs.io/en/latest/
+
+
 Yet another event organization app for Django.
 ----------------------------------------------
 

docs/conf.py

@@ -17,10 +17,10 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
 import sphinx_rtd_theme
+sys.path.insert(0, os.path.abspath('..'))
 
 # -- General configuration ------------------------------------------------
 

docs/contributing.rst

@@ -41,7 +41,7 @@ Developer's HowTo
 =================
 
 Development standards
---------------------
+---------------------
 
 * We do use standard PEP8, with extended line to 119 characters.
 * Each pull request is tested against our automated test suite (yes, PEP8 is one of the tests).
@@ -69,7 +69,7 @@ This is reusable django app, which means you have to create project first. Creat
 13. ``python manage.py runserver`` start development server, and check the app in browser
 
 Development methodology
-----------------------
+-----------------------
 
 1. You create a `fork <https://github.com/pyconsk/django-konfera/fork>`_ of the project (you do this only once. Afterwards you already have it in your GitHub, it is your repo in which you are doing all the development).
 2. Clone your fork locally ``git clone git@github.com:YOUR-GITHUB-ACCOUNT/django-konfera.git`` add upstream remote to be able to download updated into your fork ``git remote add upstream https://github.com/pyconsk/django-konfera.git``. You don't have the right to push to upstream, but do regularly pull and push to your fork to keep it up-to-date and prevent conflicts.
@@ -87,6 +87,6 @@ Development methodology
 8. Your feature is approved and merged to master of upstream, so you can check out master at your local copy: ``git checkout master`` and pull the newly approved changes from upstream ``git pull upstream master``. Pull from upstream will download your work (as one commit into master) that has been done in branch. Now you can delete your local branch ``git branch --delete XX-new-feature``, and also remote one ``git push origin :XX-new-feature``
 
 Continuous Integration
----------------------
+----------------------
 
 Once developer changes create `pull request <https://help.github.com/articles/using-pull-requests>`_ we do automated test for supported Python and Django versions and execute all unit tests in our `Travis CI <https://travis-ci.org/pyconsk/django-konfera>`_. Once the pull request is merged to the master `staging server <https://staging.pycon.sk>`_ is updated automatically, so you can see your changes in project on server immediately.

docs/index.rst

@@ -11,6 +11,7 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   installation
    contributing
    options
    talks

docs/installation.rst

@@ -0,0 +1,246 @@
+.. _installation:
+
+Installation
+============
+
+Using Pip
+---------
+
+.. code-block:: console
+
+    $ pip install django-konfera
+
+
+
+Using the Source
+----------------
+
+Get a source tarball from `pypi`_, unpack, then install with:
+
+.. code-block:: console
+
+    $ python setup.py install
+
+.. note:: As an alternative, if you don't want to mess with any packaging tool,
+          unpack the tarball and copy/move the modeltranslation directory
+          to a path listed in your ``PYTHONPATH`` environment variable.
+
+.. _pypi: http://pypi.python.org/pypi/django-konfera/
+
+
+
+Setup
+=====
+
+**TODO**
+
+
+
+Configuration
+=============
+
+Available Settings
+------------------
+
+Configuration options available, to modify application according your needs. Knowing this list of settings can save you a lot of time. You can define any of this ``settings.py`` in you project's (local) settings file.
+
+Here’s a full list of all available settings, and their default values. All settings described here can be found in ``konfera/settings.py``.
+
+.. _settings-google_analytics:
+
+``GOOGLE_ANALYTICS``
+^^^^^^^^^^^^^^^^^^^^
+
+Default: ``None``
+
+*OPTIONAL* setting. Define your Google analytics code and it will be generated on all pages. 
+
+.. note::
+    Google analytics code can be overwritten per event, in event details. 
+
+Example::
+
+    GOOGLE_ANALYTICS = 'UA-XXXXXXXX-X'
+
+
+
+.. _settings-navigation_enabled:
+
+``NAVIGATION_ENABLED``
+^^^^^^^^^^^^^^^^^^^^^^
+
+Default: ``False`` 
+
+
+
+.. _settings-navigation_brand:
+
+``NAVIGATION_BRAND``
+^^^^^^^^^^^^^^^^^^^^
+
+Default: ``'Konfera'`` 
+
+
+
+.. _settings-navigation_url:
+
+``NAVIGATION_URL``
+^^^^^^^^^^^^^^^^^^
+
+Default: ``'/'`` 
+
+
+
+.. _settings-navigation_logo:
+
+``NAVIGATION_LOGO``
+^^^^^^^^^^^^^^^^^^^
+
+Default: ``None`` 
+
+Application supports django-sitetree navigation support, weather it should be passed to template.
+
+
+
+.. _settings-currency:
+
+``CURRENCY``
+^^^^^^^^^^^^
+
+Default: ``('€', 'EUR')``
+
+Currency used in the application. (Currently support just one currency). Defined as tuple of Currency Symbol (Unicode block) and  Currency code (ISO 4217)
+
+
+
+.. _settings-talk_language:
+
+``TALK_LANGUAGE``
+^^^^^^^^^^^^^^^^^
+
+Default: ``(('SK', _('Slovak')), ('CZ', _('Czech')), ('EN', _('English')),)``
+
+
+
+.. _settings-language_default:
+
+``TALK_LANGUAGE_DEFAULT``
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: ``EN`` 
+
+
+
+.. _settings-talk_duration:
+
+``TALK_DURATION``
+^^^^^^^^^^^^^^^^^
+
+Default: ``((5, _('5 min')), (30, _('30 min')), (45, _('45 min')),)``
+
+
+
+.. _settings-landing_page:
+
+``LANDING_PAGE``
+^^^^^^^^^^^^^^^^
+
+Default: ``latest_conference`` 
+
+Setting is a composite of two keywords: *<timewise>_<event>*
+ * *<timewise>* can be: latest or earliest
+ * *<event>* can be: conference or meetup
+
+possible combinations: 
+ * latest_conference (DEFAULT)
+ * latest_meetup 
+ * earliest_conference
+ * earliest_meetup
+
+
+
+.. _settings-order_redirect:
+
+``ORDER_REDIRECT``
+^^^^^^^^^^^^^^^^^^
+
+Default: ``order_detail`` 
+
+Specify url, where user will be redirected after registering the ticket.
+
+
+
+.. _settings-register_email_notify:
+
+``REGISTER_EMAIL_NOTIFY``
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: ``False`` 
+
+Register email notification.
+
+
+
+.. _settings-proposal_email_notify:
+
+``PROPOSAL_EMAIL_NOTIFY``
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: ``False`` 
+
+Notify after submitting proposal
+
+
+
+.. _settings-email_notify_bcc:
+
+``EMAIL_NOTIFY_BCC``
+^^^^^^^^^^^^^^^^^^^^
+
+Default value: ``[]`` 
+
+Universal BCC for all notifications, MUST be empty list OR list of valid email adresses
+
+
+
+.. _settings-unpaid_order_notification_repeat:
+
+``UNPAID_ORDER_NOTIFICATION_REPEAT``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: ``3`` 
+
+How many times we should repeat the email notification
+
+
+
+.. _settings-unpaid_order_notification_repeat_delay:
+
+``UNPAID_ORDER_NOTIFICATION_REPEAT_DELAY``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: ``5`` 
+
+How long should we wait to notify about missing payment
+
+
+
+.. _settings-site_url:
+
+``SITE_URL``
+^^^^^^^^^^^^
+
+Default: ``'https://www.pycon.sk'`` 
+
+Absolute url base with protocol, should not contain trailing slash (/) at the end
+
+
+
+.. _settings-email_order_pdf_generation:
+
+``ENABLE_ORDER_PDF_GENERATION``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: ``False`` 
+
+Enable ability to store order as PDF. In order to make this functionality work, make sure django-wkhtmltopdf, with wkhtmltopdf binary.