add documentation, begining of the intall guide

doc/source/conf.py

@@ -0,0 +1,264 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# PonyTracker documentation build configuration file, created by
+# sphinx-quickstart on Wed Aug 13 12:29:56 2014.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# 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.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'PonyTracker'
+copyright = '2014, Élie Bouttier'
+
+# 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 = '0'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# 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']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'PonyTrackerdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  ('index', 'PonyTracker.tex', 'PonyTracker Documentation',
+   'Élie Bouttier', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'ponytracker', 'PonyTracker Documentation',
+     ['Élie Bouttier'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'PonyTracker', 'PonyTracker Documentation',
+   'Élie Bouttier', 'PonyTracker', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+highlight_language = 'none'

doc/source/dev.rst

@@ -0,0 +1,2 @@
+Developers guide
+################

doc/source/documentation.rst

@@ -0,0 +1,2 @@
+Documentation
+#############

doc/source/index.rst

@@ -0,0 +1,30 @@
+.. PonyTracker documentation master file, created by
+   sphinx-quickstart on Wed Aug 13 12:29:56 2014.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to PonyTracker's documentation!
+=======================================
+
+PonyTracker is a small and easy-to-use github-like issue tracker.
+
+It is reallized in Python using the Django framework.
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+    Installation <installation>
+    Documentation <documentation>
+    Developers guide <dev>
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

doc/source/installation.rst

@@ -0,0 +1,176 @@
+Installation guide
+##################
+
+Typography
+**********
+
+Commands starting by ``#`` must be run as ``root`` user.
+
+Commands starting by ``$`` must be run as ``ponytracker`` user.
+
+
+Requirements
+************
+
+You need python. Version 2.7, 3.2 or 3.4 (and probably others) are fine.
+
+This installation guide install PonyTracker in a virtualenv.
+The corresponding packages names are ``python-virtualenv`` for python 2
+and ``python3-virtualenv`` for python 3 (at least under Debian).
+
+You need also ``supervisord`` to lunch PonyTracker.
+You can install it with the package with the same name.
+
+
+Installation
+************
+
+Be sure ``/srv/www`` exists::
+
+  # mkdir -p /srv/www
+
+Create a dedicated user::
+
+  # useradd -r -m -d /srv/www/ponytracker ponytracker
+
+The following commands are executed as ``ponytracker`` user::
+
+  # su ponytracker
+  $ cd /srv/www/ponytracker
+
+Create ``log`` and ``www`` directories::
+
+  $ mkdir log www
+
+Clone the git repository and switch to the release branch::
+
+  $ git clone http://github.com/bouttier/ponytracker
+  $ cd ponytracker # we are now in /srv/www/ponytracker/ponytracker
+  $ git checkout release
+
+Copy the example configuration file::
+
+  $ cp ponytracker/local_settings.py.example ponytracker/local_settings.py
+
+Set the ``SECRET_KEY`` value.
+You can generate a secret key with ``openssl``::
+
+  $ openssl rand -base64 32
+
+If you want email notifications, set ``BASE_URL``, ``EMAIL_HOST`` (smtp relay)
+and ``FROM_ADDR``.
+
+If you want to use an over database than the default sqlite, set ``DATABASES``.
+You can found the syntaxe in the `django documentation`_.
+
+.. _django documentation: https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-DATABASES
+
+Set the static directory::
+
+  STATIC_ROOT = '/srv/www/ponytracker/www/static'
+
+Create a virtualenv and enter in it::
+
+  $ virtualenv env
+  $ source env/bin/activate
+
+Install requirements::
+
+  $ pip install -r requirements.txt
+  $ pip install gunicorn
+
+Initialize database tables::
+
+  $ python manage.py migrate
+
+Create a account for the administrator::
+
+  $ python manage.py createsuperuser
+
+Collect static files in the ``STATIC_DIR``::
+
+  $ python manage.py collecstatic --settings=ponytracker.local_settings
+
+Create the new file ``/etc/supervisor/conf.d/ponytracker.conf`` contening::
+
+  [program:ponytracker]
+  command=/srv/www/ponytracker/ponytracker/env/bin/gunicorn ponytracker.wsgi
+  directory=/srv/www/ponytracker/ponytracker
+  environment=PATH="/srv/www/ponytracker/ponytracker/env/bin"
+  user=ponytracker
+  autostart=true
+  autorestart=true
+  redirect_stderr=true
+
+Modify the file ``ponytracker/wsgi.py`` to use local settings instead of
+default settings::
+
+  os.environ.setdefault("DJANGO_SETTINGS_MODULE", "ponytracker.local_settings")
+
+In order to do not have conflict during an update, you can tell `git` to ignore
+this modification::
+
+  $ git update-index --assume-unchanged ponytracker/wsgi.py
+
+Start ``supervisord`` to run the server::
+
+  $ service supervisor start
+
+You can verify that the server is listening on ``localhost`` on port ``8000``::
+
+  $ lsof | grep LISTEN | grep ponytracker
+
+You now need to install a real web server as a front-end.
+This documentation show sample configuration files for both `apache` and
+`nginx`.
+
+
+Using Apache as front-end
+-------------------------
+
+::
+
+  <VirtualHost *:443>
+      ServerName ponytracker.example.com
+      ServerAdmin webmaster@example.com
+      DocumentRoot /var/empty
+
+      RewriteEngine on
+      RewriteRule ^(.*)$ https://%{HTTP_HOST}$1 [R=301,L]
+  </VirtualHost>
+
+  <VirtualHost *:443>
+      ServerName ponytracker.example.com
+      ServerAdmin webmaster@example.com
+      DocumentRoot /srv/www/ponytracker/www
+
+      SSLEngine on
+      SSLCipherSuite ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP:+eNULL
+      SSLCertificateFile /etc/apache2/ssl/ponytracker.example.com.pem
+      SSLCertificateKeyFile /etc/apache2/ssl/ponytracker.example.com-Key.pem
+      SSLCACertificateFile /etc/apache2/ssl/ponytracker.example.com-CA.pem
+
+      <Location /static>
+          ProxyPass !
+      </Location>
+
+      <Location />
+          ProxyPass http://127.0.0.1:8000/
+          ProxyPassReverse http://127.0.0.1:8000/
+      </Location>
+
+      ErrorLog /srv/www/ponytracker/log/error.log
+      CustomLog /srv/www/ponytracker/log/access.log combined
+  </VirtualHost>
+
+
+Using nginx as front-end
+-------------------------
+
+Forthcoming...
+
+
+Send email asynchronously with the celery worker
+************************************************
+
+Forthcoming...