Mercurial Repository: p/roundup/code: doc/conf.py comparison

comparison doc/conf.py @ 5029:333b01621772

Preparing 1.5.1 steps 7/16 7. python setup.py build_doc * sync conf.py with Sphinx 1.3

author	anatoly techtonik <techtonik@gmail.com>
date	Mon, 11 Jan 2016 21:16:08 +0300
parents	46b7d1ee4fab
children	515ab1749b14

comparison

equal deleted inserted replaced

-:46b7d1ee4fab
+:333b01621772
 # ---
 # Roundup documentation build configuration file, created by
 # sphinx-quickstart on Tue Jan 20 17:33:20 2009.
 #
-# This file is execfile()d with the current directory set to its containing dir.
+# 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).
+# Note that not all possible configuration values are present in this
+# autogenerated file.
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
-import sys, os
+import sys
+import os
 # Read Roundup version by importing it from parent directory,
 # this ensures that 'unkown version' is inserted even if
 # `roundup` is importable from other location in sys.path
 VERSION = SHORTVER = '(unknown version)'
 finally:
 sys.path = SYSSAVE
-# If your extensions are in another directory, add it here. If the directory
+# If extensions (or modules to document with autodoc) are in another directory,
-# is relative to the documentation root, use os.path.abspath to make it
+# add these directories to sys.path here. If the directory is relative to the
-# absolute, like shown here.
+# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.append(os.path.abspath('.'))
+#sys.path.insert(0, os.path.abspath('.'))
-# General configuration
+# -- General configuration ------------------------------------------------
-# ---------------------
+# If your documentation needs a minimal Sphinx version, state it here.
-# Add any Sphinx extension module names here, as strings. They can be extensions
+#needs_sphinx = '1.0'
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
 #extensions = ['toctree']
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
-# The suffix of source filenames.
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# source_suffix = ['.rst', '.md']
 source_suffix = '.txt'
 # The encoding of source files.
 #source_encoding = 'utf-8'
 # The full version, including alpha/beta/rc tags.
 release = VERSION
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+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.
+# List of patterns, relative to source directory, that match files and
-#unused_docs = []
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
-# List of directories, relative to source directory, that shouldn't be searched
-# for source files.
+# The reST default role (used for this markup: `text`) to use for all
-exclude_trees = ['.build']
+# documents.
-# 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
 #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.
-# Options for HTML output
+#modindex_common_prefix = []
-# -----------------------
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+# -- Options for HTML output ----------------------------------------------
+#-- pre Sphinx 1.3
 # 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 = 'default.css'
+#-- Sphinx 1.3
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#html_theme = 'alabaster'
+# 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 = 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']
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
 html_extra_path = ['html_extra']
-# 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
 #html_use_smartypants = True
 # Custom sidebar templates, maps document names to template names.
 #html_sidebars = {}
-html_collapse_toctree = True
 # 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
+#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, the reST sources are included in the HTML build as _sources/<name>.
+# If true, links to the reST sources are added to the pages.
-#html_copy_source = True
+#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 = ''
-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
+#html_file_suffix = None
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+#html_search_language = 'en'
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Roundupdoc'
+htmlhelp_basename = 'roundupdoc'
+# -- Options for LaTeX output ---------------------------------------------
-# Options for LaTeX output
-# ------------------------
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
-# The paper size ('letter' or 'a4').
+#'papersize': 'letterpaper',
-#latex_paper_size = 'letter'
 # The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+#'pointsize': '10pt',
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+# Latex figure (float) alignment
+#'figure_align': 'htbp',
+}
 # Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, document class [howto/manual]).
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
 latex_documents = [
 ('docs/index', 'Roundup.tex', u'Roundup Documentation',
 u'Richard Jones', 'manual'),
 ]
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
 #latex_use_parts = False
-# Additional stuff for the LaTeX preamble.
+# If true, show page references after internal links.
-#latex_preamble = ''
+#latex_show_pagerefs = False
+# If true, show URL addresses after external links.
+#latex_show_urls = False
 # Documents to append as an appendix to all manuals.
 #latex_appendices = []
 # If false, no module index is generated.
-#latex_use_modindex = True
+#latex_domain_indices = True

Mercurial > p > roundup > code

comparison doc/conf.py @ 5029:333b01621772