"Fossies" - the Fresh Open Source Software Archive

Member "cheetah3-3.2.6.post2/docs/conf.py" (20 Apr 2021, 6702 Bytes) of package /linux/www/cheetah3-3.2.6.post2.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) Python source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. For more information about "conf.py" see the Fossies "Dox" file reference documentation and the last Fossies "Diffs" side-by-side code changes report: 3-3.2.1_vs_3-3.2.2.

    1 # -*- coding: utf-8 -*-
    2 #
    3 # Cheetah Template Engine documentation build configuration file, created by
    4 # sphinx-quickstart on Sun May 31 22:23:43 2009.
    5 #
    6 # This file is execfile()d with the current directory set
    7 # to its containing dir.
    8 #
    9 # Note that not all possible configuration values are present in this
   10 # autogenerated file.
   11 #
   12 # All configuration values have a default; values that are commented out
   13 # serve to show the default.
   14 
   15 from datetime import date
   16 import os
   17 import sys
   18 from Cheetah.Version import Version
   19 
   20 # If extensions (or modules to document with autodoc) are in another directory,
   21 # add these directories to sys.path here. If the directory is relative to the
   22 # documentation root, use os.path.abspath to make it absolute, like shown here.
   23 # sys.path.append(os.path.abspath('.'))
   24 sys.path.insert(0, os.path.abspath('..'))
   25 
   26 # -- General configuration ----------------------------------------------------
   27 
   28 # Add any Sphinx extension module names here, as strings.
   29 # They can be extensions coming with Sphinx (named 'sphinx.ext.*')
   30 # or your custom ones.
   31 extensions = [
   32     'sphinx.ext.autodoc',
   33 ]
   34 
   35 # Add any paths that contain templates here, relative to this directory.
   36 templates_path = ['_templates']
   37 
   38 # The suffix of source filenames.
   39 source_suffix = '.rst'
   40 
   41 # The encoding of source files.
   42 # source_encoding = 'utf-8'
   43 
   44 # The master toctree document.
   45 master_doc = 'index'
   46 
   47 # General information about the project.
   48 project = u'Cheetah3'
   49 copyright = u'2017-%d, Oleg Broytman; 2009-2012, R. Tyler Croy; ' \
   50             u'2001-2008, The Cheetah Development Team.' % date.today().year
   51 
   52 # The version info for the project you're documenting, acts as replacement for
   53 # |version| and |release|, also used in various other places throughout the
   54 # built documents.
   55 #
   56 # The short X.Y version.
   57 version = '.'.join(Version.split('.')[:2])
   58 # The full version, including alpha/beta/rc tags.
   59 release = Version
   60 
   61 # The language for content autogenerated by Sphinx. Refer to documentation
   62 # for a list of supported languages.
   63 # language = None
   64 
   65 # There are two options for replacing |today|: either, you set today to some
   66 # non-false value, then it is used:
   67 # today = ''
   68 # Else, today_fmt is used as the format for a strftime call.
   69 # today_fmt = '%B %d, %Y'
   70 
   71 # List of documents that shouldn't be included in the build.
   72 # unused_docs = []
   73 
   74 # List of directories, relative to source directory, that shouldn't be searched
   75 # for source files.
   76 exclude_trees = ['_build']
   77 
   78 # The reST default role (used for markup `text`) to use for all documents.
   79 # default_role = None
   80 
   81 # If true, '()' will be appended to :func: etc. cross-reference text.
   82 add_function_parentheses = True
   83 
   84 # If true, the current module name will be prepended to all description
   85 # unit titles (such as .. function::).
   86 add_module_names = True
   87 
   88 # If true, sectionauthor and moduleauthor directives will be shown in the
   89 # output. They are ignored by default.
   90 # show_authors = False
   91 
   92 # The name of the Pygments (syntax highlighting) style to use.
   93 pygments_style = 'sphinx'
   94 
   95 # A list of ignored prefixes for module index sorting.
   96 # modindex_common_prefix = []
   97 
   98 
   99 # -- Options for HTML output --------------------------------------------------
  100 
  101 # The theme to use for HTML and HTML Help pages.  Major themes that come with
  102 # Sphinx are currently 'default' and 'sphinxdoc'.
  103 html_theme = 'sphinxdoc'
  104 
  105 # Theme options are theme-specific and customize the look and feel of a theme
  106 # further.  For a list of options available for each theme, see the
  107 # documentation.
  108 # html_theme_options = {}
  109 
  110 # Add any paths that contain custom themes here, relative to this directory.
  111 html_theme_path = ['.']
  112 
  113 # The name for this set of Sphinx documents.  If None, it defaults to
  114 # "<project> v<release> documentation".
  115 html_title = u'Cheetah3 - The Python-Powered Template Engine'
  116 
  117 # A shorter title for the navigation bar.  Default is the same as html_title.
  118 # html_short_title = None
  119 
  120 # The name of an image file (relative to this directory) to place at the top
  121 # of the sidebar.
  122 # html_logo = None
  123 
  124 # The name of an image file (within the static path) to use as favicon of the
  125 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
  126 # pixels large.
  127 # html_favicon = None
  128 
  129 # Add any paths that contain custom static files (such as style sheets) here,
  130 # relative to this directory. They are copied after the builtin static files,
  131 # so a file named "default.css" will overwrite the builtin "default.css".
  132 html_static_path = ['_static']
  133 
  134 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  135 # using the given strftime format.
  136 html_last_updated_fmt = '%b %d, %Y'
  137 
  138 # If true, SmartyPants will be used to convert quotes and dashes to
  139 # typographically correct entities.
  140 html_use_smartypants = True
  141 
  142 # Custom sidebar templates, maps document names to template names.
  143 # html_sidebars = {}
  144 
  145 # Additional templates that should be rendered to pages, maps page names to
  146 # template names.
  147 # html_additional_pages = {}
  148 
  149 # If false, no module index is generated.
  150 html_use_modindex = True
  151 
  152 # If false, no index is generated.
  153 html_use_index = True
  154 
  155 # If true, the index is split into individual pages for each letter.
  156 # html_split_index = False
  157 
  158 # If true, links to the reST sources are added to the pages.
  159 html_show_sourcelink = True
  160 
  161 # If true, an OpenSearch description file will be output, and all pages will
  162 # contain a <link> tag referring to it.  The value of this option must be the
  163 # base URL from which the finished HTML is served.
  164 # html_use_opensearch = ''
  165 
  166 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
  167 # html_file_suffix = ''
  168 
  169 # Output file base name for HTML help builder.
  170 htmlhelp_basename = 'CheetahTemplateEnginedoc'
  171 
  172 
  173 # -- Options for LaTeX output -------------------------------------------------
  174 
  175 # The paper size ('letter' or 'a4').
  176 # latex_paper_size = 'letter'
  177 
  178 # The font size ('10pt', '11pt' or '12pt').
  179 # latex_font_size = '10pt'
  180 
  181 # Grouping the document tree into LaTeX files. List of tuples
  182 # (source start file, target name, title,
  183 # author, documentclass [howto/manual]).
  184 latex_documents = [
  185     ('index', 'CheetahTemplateEngine.tex',
  186      u'Cheetah Template Engine Documentation',
  187      u'R. Tyler Ballance', 'manual'),
  188 ]
  189 
  190 # The name of an image file (relative to this directory) to place at the top of
  191 # the title page.
  192 # latex_logo = None
  193 
  194 # For "manual" documents, if this is true, then toplevel headings are parts,
  195 # not chapters.
  196 # latex_use_parts = False
  197 
  198 # Additional stuff for the LaTeX preamble.
  199 # latex_preamble = ''
  200 
  201 # Documents to append as an appendix to all manuals.
  202 # latex_appendices = []
  203 
  204 # If false, no module index is generated.
  205 latex_use_modindex = True