Commits

Tyler Butler committed 3ffc623

Backup.

Comments (0)

Files changed (3)

default_settings.diff

+# HG changeset patch
+# Parent 1566daf6d4c1ed5aa65ffad9b51c2d1d4e9d424e
+Playing around with a default settings idea.
+
+diff --git a/engineer/settings_defaults.py b/engineer/settings_defaults.py
+new file mode 100644
+--- /dev/null
++++ b/engineer/settings_defaults.py
+@@ -0,0 +1,20 @@
++
++__author__ = 'tyler@tylerbutler.com'
++
++### django-compress ###
++COMPRESS_PRECOMPILERS = (
++    ('text/less', 'lessc {infile}'),
++    )
++
++COMPRESS_CSS_FILTERS = [
++    'compressor.filters.css_default.CssAbsoluteFilter',
++    'compressor.filters.cssmin.CSSMinFilter'
++]
++
++COMPRESS_JS_FILTERS = [
++    'compressor.filters.jsmin.SlimItFilter'
++]
++
++COMPRESS_OUTPUT_DIR = 'COMPRESSED'
++### END django-compress ###
++

documentation1.diff

+# HG changeset patch
+# Parent 5167a4bc1dc7d761f9e742184cfc3542848487fc
+Documentation.
+
+diff --git a/docs_source/dark_rainbow.rst b/docs_source/dark_rainbow.rst
+new file mode 100644
+--- /dev/null
++++ b/docs_source/dark_rainbow.rst
+@@ -0,0 +1,9 @@
++==================
++Dark Rainbow Theme
++==================
++
++Blocks
++======
++
++Theme Settings
++==============
+diff --git a/docs_source/index.rst b/docs_source/index.rst
+--- a/docs_source/index.rst
++++ b/docs_source/index.rst
+@@ -1,3 +1,4 @@
++=============================
+ django-engineer documentation
+ =============================
+ 
+@@ -6,10 +7,13 @@
+ ..  toctree::
+     :maxdepth: 2
+ 
++    installation
+     input_processing
+     post_format
+     template_pages
++    views_and_urls
+     themes
++    settings
+ 
+ Indices and tables
+ ==================
+diff --git a/docs_source/installation.rst b/docs_source/installation.rst
+new file mode 100644
+--- /dev/null
++++ b/docs_source/installation.rst
+@@ -0,0 +1,65 @@
++============
++Installation
++============
++
++Install from the Bitbucket repository using pip::
++
++    pip install -e hg+https://bitbucket.org/tylerbutler/django-engineer#egg=engineer
++
++This will install all requirements as well as the core django-engineer code.
++
++Add the following applications to your ``INSTALLED_APPS`` setting in your Django settings file::
++
++    'grappelli.dashboard',
++    'grappelli',
++    'django.contrib.admin',
++    'markitup',
++    'taggit',
++    'typogrify',
++    'compressor',
++    'engineer',
++
++Add the ``site_variables`` context processor to your ``TEMPLATE_CONTEXT_PROCESSORS`` setting in your Django
++settings file.
++
++::
++
++    TEMPLATE_CONTEXT_PROCESSORS = (
++        ...
++        # Other context processors
++        ...
++        'engineer.context_processors.site_variables',
++        )
++
++Make sure the django-compressor static file finder is in your ``STATICFILES_FINDERS`` setting::
++
++    STATICFILES_FINDERS = (
++        'django.contrib.staticfiles.finders.FileSystemFinder',
++        'django.contrib.staticfiles.finders.AppDirectoriesFinder',
++        'compressor.finders.CompressorFinder', # django-compressor finder
++        )
++
++Add the following to your Django settings file::
++
++    MARKITUP_FILTER = ('engineer.util.markdown_wrapper', {})
++    MARKITUP_AUTO_PREVIEW = True
++    MARKITUP_SET = 'markitup/sets/markdown'
++
++Set any theme-specific variables in your settings file. See the :ref:`themes` documentation for more details.
++
++::
++
++    ENGINEER_THEME_VARIABLES = {
++        'site_title': 'My Engineer-Powered Site',
++        }
++
++Include the markitup and engineer URLs in your urlconf::
++
++    urlpatterns = patterns('',
++        ...
++        # Other URLs
++        ...
++        url(r'^markitup/', include('markitup.urls')),
++        url(r'', include('engineer.urls')),
++    )
++
+diff --git a/docs_source/settings.rst b/docs_source/settings.rst
+new file mode 100644
+--- /dev/null
++++ b/docs_source/settings.rst
+@@ -0,0 +1,14 @@
++========
++Settings
++========
++
++Theme-related Settings
++======================
++
++ENGINEER_THEME
++    The module and name of the dictionary that contains the theme settings.
++    Defaults to ``engineer.themes.DarkRainbow``.
++    Custom themes should be defined as a dictionary containing the properties of the theme.
++
++ENGINEER_THEME_VARIABLES
++    Most themes have a bunch of variables that you can override. Dictionary.
+diff --git a/docs_source/themes.rst b/docs_source/themes.rst
+--- a/docs_source/themes.rst
++++ b/docs_source/themes.rst
+@@ -1,18 +1,41 @@
++======
++Themes
++======
+ 
+-Base template blocks that should be overridden:
++Themes provide a way to modify the look and feel of an engineer-based site without creating a bunch of templates
++yourself. You will have to create *some* templates, but themes handle a lot of the manual work for you, allowing
++you to focus on the content of your site rather than the basic layout.
+ 
+-site_title
+-    The title of the site.
++You might also choose to :ref:`create your own theme` leveraging the theme infrastructure provided in engineer, or you
++could wire up your own :doc:`views and urls <views_and_urls>` if you want.
+ 
++Choosing a theme
++================
+ 
+-Theme-related settings:
++When you first :doc:`install <installation>`
++engineer, your site will use the :doc:`Dark Rainbow <dark_rainbow>` theme.
+ 
+-ENGINEER_THEME
+-    The module and name of the dictionary that contains the theme settings.
+-    Defaults to ``engineer.themes.DarkRainbow``.
+-    Custom themes should be defined as a dictionary containing the properties of the theme.
++In order to customize the theme, you'll need to create templates in the ``engineer`` directory in your project's
++template directory. Each theme comes with a set of base templates that you can extend to add your own content.
++These templates will expose a number of blocks that can be overridden in your own templates in the typical Django
++way. While most themes will expose a number of different blocks, these are standard across all themes:
+ 
+-ENGINEER_THEME_VARIABLES
+-    Most themes have a bunch of variables that you can override. Dictionary.
++*(from engineer/themes/_base.html)*
+ 
+-Site content
+\ No newline at end of file
++stylesheets
++    Use this block to add your own stylesheets.
++scripts_top
++    Use this block to insert your own scripts in the ``<head>`` of the page.
++scripts_bottom
++    Use this block to insert your own scripts at the very bottom of the ``<body>``.
++
++Included Themes
++===============
++
++..  toctree::
++    :maxdepth: 2
++
++    dark_rainbow
++
++Creating Your Own Themes
++========================
+diff --git a/docs_source/views_and_urls.rst b/docs_source/views_and_urls.rst
+new file mode 100644
+--- /dev/null
++++ b/docs_source/views_and_urls.rst
+@@ -0,0 +1,3 @@
++==============
++Views and URLs
++==============
+diff --git a/requirements.txt b/requirements.txt
+--- a/requirements.txt
++++ b/requirements.txt
+@@ -6,6 +6,7 @@
+ PyYAML
+ django-autoslug>=1.4.1
+ django-appconf
++django-compressor
+ markdown
+ typogrify
+ 
 2012-01-21_18-57-31_r35+.diff
 2012-01-21_20-34-20_r36+.diff
 template_pages.diff
+documentation1.diff
+default_settings.diff
 gh_buttons.diff
 # Placed by Bitbucket