theme: cleanup to layout.html and conf.py

Author: Sam Kleinman

conf.py

@@ -5,9 +5,6 @@
 #
 # This file is execfile()d with the current directory set to its containing dir.
 
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
 import sys
 import os
 import datetime
@@ -16,40 +13,34 @@
 
 import mongodb_docs_meta
 
-meta = { 'branch': mongodb_docs_meta.get_branch(),
-         'commit': mongodb_docs_meta.get_commit(),
-         'manual_path': mongodb_docs_meta.get_manual_path(),
-         'date': str(datetime.date.today().year),
+meta = {
+    'branch': mongodb_docs_meta.get_branch(),
+    'commit': mongodb_docs_meta.get_commit(),
+    'manual_path': mongodb_docs_meta.get_manual_path(),
+    'date': str(datetime.date.today().year),
 }
 
 # -- General configuration ----------------------------------------------------
 
 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.intersphinx", "sphinx.ext.extlinks", "sphinx.ext.todo", "mongodb_domain", "additional_directives", "aggregation_domain"]
+extensions = [
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.extlinks',
+    'sphinx.ext.todo',
+    'mongodb_domain',
+    'additional_directives',
+    'aggregation_domain',
+]
 
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ['.templates']
+exclude_patterns = []
 
-# The suffix of source filenames.
 source_suffix = '.txt'
 
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
 master_doc = 'contents'
-
-# General information about the project.
 project = u'MongoDB'
 copyright = u'2011-' + meta['date'] + ', 10gen, Inc.'
-
-# 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 value of ``version`` is used in the paths for the curl commands.
-
 version = '2.2.2'
 release = version
 
@@ -59,91 +50,35 @@
               '.. |year| replace:: ' + meta['date'] + BREAK +
               '.. |hardlink| replace:: http://docs.mongodb.org/' + meta['branch'])
 
-# 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 = []
-
 extlinks = {
     'issue': ('https://jira.mongodb.org/browse/%s', '' ),
     'wiki': ('http://www.mongodb.org/display/DOCS/%s', ''),
     'api': ('http://api.mongodb.org/%s', ''),
     'source': ('https://github.com/mongodb/mongo/blob/master/%s', ''),
     'docsgithub' : ( 'http://github.com/mongodb/docs/blob/' + meta['branch'] + '/%s', ''),
     'hardlink' : ( 'http://docs.mongodb.org/' + meta['branch'] + '/%s', '')
-    }
+}
 
 intersphinx_mapping = {
         'pymongo': ('http://api.mongodb.org/python/current/', None),
         'python' : ('http://docs.python.org/', None),
         'django': ('https://django.readthedocs.org/en/latest/', None),
         'djangomongodbengine': ('http://django-mongodb.org/', None),
         'djangotoolbox' : ('http://djangotoolbox.readthedocs.org/en/latest/', None),
-        }
+}
 
 # -- 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 = 'mongodb'
-
-# 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 = project + ' Manual'
+htmlhelp_basename = 'MongoDBdoc'
 
-# 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 = ".static/logo-mongodb.png"
-
-# 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 = ['source/.static']
 
-# 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'
-
 html_copy_source = False
 html_use_smartypants = True
 html_domain_indices = True
@@ -155,27 +90,21 @@
 
 manual_edition_path = 'http://docs.mongodb.org/' + meta['branch'] + '/' + project + '-Manual-' + meta['branch']
 
-html_theme_options = { 'branch': meta['branch'],
-                       'pdfpath':  manual_edition_path + '.pdf',
-                       'epubpath':  manual_edition_path + '.epub',
-                       'manual_path': meta['manual_path'],
-                       'repo_name': 'docs',
-                       'jira_project': 'DOCS',
-                       'google_analytics': 'UA-7301842-8',
-                       'is_manual': True,
-                       'project': 'manual',
-                       }
-
-# 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 = 'MongoDBdoc'
+html_theme_options = {
+    'branch': meta['branch'],
+    'pdfpath':  manual_edition_path + '.pdf',
+    'epubpath':  manual_edition_path + '.epub',
+    'manual_path': meta['manual_path'],
+    'repo_name': 'docs',
+    'jira_project': 'DOCS',
+    'google_analytics': 'UA-7301842-8',
+    'is_manual': True,
+    'project': 'manual',
+}
+
+html_sidebars = {
+    '**': ['localtoc.html', 'pagenav.html', 'wikisidebar.html'],
+}
 
 # -- Options for LaTeX output --------------------------------------------------
 
@@ -187,21 +116,18 @@
     ('crud', 'MongoDB-crud.tex', u'MongoDB CRUD Operations Introduction', u'MongoDB Documentation Project', 'manual'),
 ]
 
-latex_elements = { 'preamble': '\DeclareUnicodeCharacter{FF04}{\$} \DeclareUnicodeCharacter{FF0E}{.}',
-                   'pointsize': '10pt',
-                   'papersize': 'letterpaper'
-                   }
+latex_elements = {
+    'preamble': '\DeclareUnicodeCharacter{FF04}{\$} \DeclareUnicodeCharacter{FF0E}{.}',
+    'pointsize': '10pt',
+    'papersize': 'letterpaper'
+}
 
 latex_use_parts = True
 latex_show_pagerefs = True
 latex_show_urls = False
 latex_domain_indices = True
-
-# The name of an image file (relative to this directory) to place at the top of the title page.
-#latex_logo = None
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
+latex_logo = None
+latex_appendices = []
 
 # -- Options for manual page output --------------------------------------------
 
@@ -244,7 +170,5 @@
 epub_identifier = 'http://docs.mongodb.org/' + meta['branch']
 epub_exclude_files = []
 
-# HTML files that should be inserted before/after the pages created by sphinx.
-# The format is a list of tuples containing the path and title.
-#epub_pre_files = []
-#epub_post_files = []
+epub_pre_files = []
+epub_post_files = []

themes/mongodb/analytics.html

@@ -0,0 +1,23 @@
+<script type="text/javascript">
+var _gaq = _gaq || [];
+var pluginUrl = (('https:' == document.location.protocol) ? 'https://ssl.' : 'http://www.') + 'google-analytics.com/plugins/ga/inpage_linkid.js';
+_gaq.push(['_require', 'inpage_linkid', pluginUrl]);
+_gaq.push(['_setAccount', '{{theme_google_analytics}}']);
+_gaq.push(['_setDomainName', 'docs.mongodb.org']);
+{%- if (pagename == "meta/401") or (pagename == "meta/403") or (pagename == "meta/404") or (pagename == "meta/410") %}
+_gaq.push(['_trackPageview', '/{{theme_manaul_path}}/{{pagename}}/?page=' + document.location.pathname + document.location.search + '&from=' + document.referrer]);
+{%- else %}
+_gaq.push(['_trackPageview']);
+{%- endif %}
+(function() {
+        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+        var s = document.getElementsByTagName('script')[0];
+        s.parentNode.insertBefore(ga, s);
+        })();
+</script>
+
+<script type="text/javascript">
+document.write(unescape("%3Cscript src='" + document.location.protocol + "//munchkin.marketo.net/munchkin.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script>try { mktoMunchkin("017-HGS-593"); } catch(e) {}</script>