initial commit with file structure according to CakePHP's docs.

Author: fahad19

.gitignore

@@ -0,0 +1,4 @@
+*.pyc
+build/*
+*/_build/*
+.DS_Store

Makefile

@@ -0,0 +1,31 @@
+# MakeFile for building all the docs at once.
+# Inspired by the Makefile used by bazaar. 
+# http://bazaar.launchpad.net/~bzr-pqm/bzr/2.3/
+
+PYTHON = python
+
+.PHONY: all clean html latexpdf epub htmlhelp
+
+# Dependencies to perform before running other builds.
+SPHINX_DEPENDENCIES = \
+	en/Makefile
+
+# Copy-paste the english Makefile everwhere its needed.
+%/Makefile : en/Makefile
+	$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
+
+# Make the HTML version of the documentation with correctly nested language folders.
+html: $(SPHINX_DEPENDENCIES)
+	cd en && make html LANG=en
+
+htmlhelp: $(SPHINX_DEPENDENCIES)
+	cd en && make htmlhelp LANG=en
+
+epub: $(SPHINX_DEPENDENCIES)
+	cd en && make epub LANG=en
+
+latexpdf: $(SPHINX_DEPENDENCIES)
+	cd en && make latexpdf LANG=en
+
+clean:
+	rm -rf build/*

README.mdown

@@ -0,0 +1,52 @@
+Croogo Experimental Docs
+=========================
+
+This documentation will hopefully one day replace the existing wiki.  Hopefully enabling community contributions and enabling multiple format documentation generation.
+
+Requirements
+------------
+
+You can read all of the documentation within as its just in plain text files, marked up with ReST text formatting.  To build the documentation you'll need the following:
+
+* Make
+* Python
+* Sphinx
+* PhpDomain for sphinx
+
+You can install sphinx using:
+
+	easy_install sphinx
+
+You can install the phpdomain using:
+
+	easy_install sphinxcontrib-phpdomain
+
+Building the documentation
+--------------------------
+
+After installing the require packages you can build the documentation using `Make`
+
+	make html
+
+This will generate all the documentation in an html form.  Other output such as 'epub', 'pdf' and 'htmlhelp' are not fully complete at this time.
+
+After making changes to the documentation, you can build the html version of the docs by using `make html` again.  This will build only the html files that have had changes made to them.
+
+
+Contributing
+------------
+
+Contributing to the documentation is pretty simple. There are currently a number of outstanding issues that need to be addressed.  We've tried to flag these with `.. todo::` where possible.  To see all the outstanding todo's add the following to your `config/all.py`
+
+	todo_include_todos = True
+
+After rebuilding the html content, you should see a list of existing todo items at the bottom of the table of contents.
+
+You are also welcome to make and suggestions for new content as commits in a github fork.  Please make any totally new sections in a separate branch.  This makes changes far easier to integrate later on.
+
+Translations
+------------
+
+Contributing translations requires that you make a new directory using the two letter name for your language.  As content is translated, directories mirroring the english content should be created with localized content.
+
+

config/__init__.py

@@ -0,0 +1,283 @@
+# Global configuration information used across all the 
+# translations of documentation.
+#
+
+# -- 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.todo',
+    'sphinxcontrib.phpdomain',
+    'config.cakei18n'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+# templates_path = []
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'contents'
+
+# General information about the project.
+project = u'Croogo Docs'
+copyright = u'2012'
+
+# 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 = '1.4'
+
+# The full version, including alpha/beta/rc tags.
+release = '1.4.2'
+
+# 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 = ['themes']
+
+# 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 = []
+
+highlight_language = 'php'
+
+
+# -- 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 = 'croogo'
+
+# 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 = ['../themes']
+
+# 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
+html_short_title = u'Croogo Docs 1.4'
+
+# 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 = []
+
+# 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 = {
+ '**' : ['globaltoc.html']
+}
+
+# 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 = 'CroogoDocs'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+latex_font_size = '11pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('pdf-contents', 'CroogoDocs.tex', u'Croogo Documentation',
+   u'Croogo Community', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+latex_logo = '../themes/croogo/static/pdf-logo.png'
+
+# 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 = True
+
+# If true, show URL addresses after external links.
+latex_show_urls = 'footnote'
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+# latex_domain_indices = True
+
+
+preamb = ur'''
+% Custom colors.
+\definecolor{ChapterColor}{RGB}{201,36,52}
+\definecolor{TitleColor}{RGB}{0,0,0}
+
+% No section numbering
+\setcounter{secnumdepth}{0}
+
+% Make chapter titles red.
+\ChNameVar{\color{TitleColor}\Large}
+\ChNumVar{\color{TitleColor}\Large}
+\ChTitleVar{\color{ChapterColor}\Huge\sf}
+
+% link colors
+\definecolor{InnerLinkColor}{RGB}{65,114,130}
+\definecolor{OuterLinkColor}{RGB}{0,61,76}
+
+% background and border for code examples.
+\definecolor{VerbatimColor}{RGB}{242,242,242}
+\definecolor{VerbatimBorderColor}{RGB}{230,230,230}
+'''
+
+latex_elements ={
+    'preamble': preamb,
+    'fncychap': '\\usepackage[Sonny]{fncychap}'
+}
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'croogodocs', u'Croogo Documentation',
+     [u'Croogo'], 1)
+]
+
+
+# -- Options for Epub output ---------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u'Croogo Docs'
+epub_author = u'Croogo.'
+epub_publisher = u'Croogo.'
+epub_copyright = u'2012, Croogo.'
+
+epub_theme = 'croogo-epub'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = [
+    'index.html',
+    'pdf-contents.html',
+    'search.html',
+]
+
+# The depth of the table of contents in toc.ncx.
+epub_tocdepth = 2
+
+# Allow duplicate toc entries.
+epub_tocdup = False
+
+# Languages available.
+languages = ['en']

config/all.py

@@ -0,0 +1,38 @@
+import os
+from sphinx.util.osutil import SEP
+"""
+CakePHP i18n extension.
+
+A simple sphinx extension for adding
+i18n links to other sub doc projects.
+"""
+
+def setup(app):
+    app.connect('html-page-context', append_template_ctx)
+    app.add_config_value('languages', [], '')
+    return app
+
+def append_template_ctx(app, pagename, templatename, ctx, event_arg):
+    def lang_link(lang, path):
+        """
+        Generates links to other language docs.
+        """
+        dots = []
+        for p in path.split(SEP):
+            dots.append('..')
+        return SEP.join(dots) + SEP + lang + SEP + path + app.builder.link_suffix
+
+    def has_lang(lang, path):
+        """
+        Check to see if a language file exists for a given path/RST doc.:
+        """
+        possible = '..' + SEP + lang +  SEP + path + app.config.source_suffix
+        full_path = os.path.realpath(os.path.join(os.getcwd(), possible))
+
+        return os.path.isfile(full_path)
+
+    ctx['lang_link'] = lang_link
+    ctx['has_lang'] = has_lang
+
+    ctx['languages'] = app.config.languages
+    ctx['language'] = app.config.language