Skip to content
Browse files

Stripped down the Sphinx config file

  • Loading branch information...
1 parent ae06a8c commit 7458f69ac786e4cf0598ce0fa30027b1d5ccf672 @whiteinge whiteinge committed Oct 10, 2011
Showing with 22 additions and 157 deletions.
  1. +22 −157 doc/conf.py
View
179 doc/conf.py
@@ -13,26 +13,6 @@
# -- 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 = ['saltdocs', 'sphinx.ext.autodoc', 'sphinx.ext.extlinks']
-
-# 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 = u'Salt'
copyright = u'2011, Thomas S. Hatch'
@@ -45,44 +25,18 @@
# The full version, including alpha/beta/rc tags.
release = version
-# A substitution for linking to the latest release tarball
-rst_prolog = """\
-.. |latest| replace:: https://github.com/downloads/thatch45/salt/salt-%s.tar.gz
-""" % __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 patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
+master_doc = 'index'
+templates_path = ['_templates']
exclude_patterns = ['_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
+extensions = ['saltdocs', 'sphinx.ext.autodoc', 'sphinx.ext.extlinks']
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+modindex_common_prefix = ['salt.']
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# Define a substitution for linking to the latest release tarball
+rst_prolog = """\
+.. |latest| replace:: https://github.com/downloads/thatch45/salt/salt-%s.tar.gz
+""" % __version__
# A shortcut for linking to tickets on the GitHub issue tracker
extlinks = {
@@ -91,127 +45,38 @@
'issue': ('https://github.com/thatch45/salt/issues/%s', 'issue '),
}
-# -- Options for HTML output ---------------------------------------------------
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
+### HTML options
html_theme = 'agogo'
+html_title = None
+html_short_title = 'Salt'
-# 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 = 'Salt'
-
-# 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_logo = 'salt.png'
+html_favicon = 'salt.ico'
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_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
+html_sidebars = {'index': ['indexsidebar.html']}
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+html_last_updated_fmt = '%b %d, %Y'
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+html_additional_pages = {'index': 'index.html'}
-# 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_show_sourcelink = False
+html_show_sphinx = True
+html_show_copyright = True
#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 = 'Saltdoc'
-
-
-# -- 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, documentclass [howto/manual]).
+### Latex options
latex_documents = [
('index', 'Salt.tex', u'Salt Documentation',
u'Thomas Hatch', '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
-
-# 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
-
+latex_logo = '_static/salt.png'
-# -- Options for manual page output --------------------------------------------
+### Manpage options
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
authors = [

0 comments on commit 7458f69

Please sign in to comment.
Something went wrong with that request. Please try again.