summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorAsk Solem <askh@opera.com>2010-07-23 15:12:49 +0200
committerAsk Solem <askh@opera.com>2010-07-23 15:12:49 +0200
commitcd2022670f2da5fc6b49eda3844b8646059c2861 (patch)
treedee70f9bf0d311391c6f5fe34d3b0e91b455360e /docs/conf.py
parentad45115c0ee65266bcd2d01650a02551eaf0d3ea (diff)
downloadkombu-cd2022670f2da5fc6b49eda3844b8646059c2861.tar.gz
Added celery theme to documentation
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py145
1 files changed, 8 insertions, 137 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 271dcdf5..f7f4f834 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,17 +1,4 @@
# -*- coding: utf-8 -*-
-#
-# Kombu documentation build configuration file, created by
-# sphinx-quickstart on Mon May 18 21:37:44 2009.
-#
-# This file is execfile()d with the current directory set to its
-#containing dir.
-#
-# The contents of this file are pickled, so don't put values in the namespace
-# that aren't pickleable (module imports are okay, they're removed
-#automatically).
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
import sys
import os
@@ -19,17 +6,13 @@ import os
# If your extensions are in another directory, add it 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, "../")
+sys.path.append(os.path.join(os.pardir, "tests"))
import kombu
-
# General configuration
# ---------------------
-# 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']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['.templates']
@@ -37,9 +20,6 @@ templates_path = ['.templates']
# The suffix of source filenames.
source_suffix = '.rst'
-# The encoding of source files.
-#source_encoding = 'utf-8'
-
# The master toctree document.
master_doc = 'index'
@@ -56,145 +36,36 @@ version = ".".join(map(str, kombu.VERSION[0:2]))
# The full version, including alpha/beta/rc tags.
release = kombu.__version__
-# 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 documents that shouldn't be included in the build.
-#unused_docs = []
-
-# List of directories, relative to source directory, that shouldn't be searched
-# for source files.
exclude_trees = ['.build']
-# 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 = 'trac'
-#html_translator_class = "djangodocs.DjangoHTMLTranslator"
-
-
-# Options for HTML output
-# -----------------------
-
-# The style sheet to use for HTML and HTML Help pages. A file of that name
-# must exist either in Sphinx' static/ path, or in one of the custom paths
-# given in html_static_path.
-#html_style = 'agogo.css'
-
-# 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']
-# 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_use_modindex = 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, the reST sources are included in the HTML build as _sources/<name>.
-#html_copy_source = 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 = ''
-
-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'kombudoc'
-
-
-# Options for LaTeX output
-# ------------------------
-
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
-
-# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, document class
-# [howto/manual]).
latex_documents = [
('index', 'Kombu.tex', ur'Kombu Documentation',
ur'Ask Solem', '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
-
-# 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_use_modindex = True
-
-html_theme = "nature"
+html_theme = "celery"
html_theme_path = ["_theme"]
+html_sidebars = {
+ 'index': ['sidebarintro.html', 'sourcelink.html', 'searchbox.html'],
+ '**': ['sidebarlogo.html', 'localtoc.html', 'relations.html',
+ 'sourcelink.html', 'searchbox.html'],
+}