"Fossies" - the Fresh Open Source Software Archive

Member "roundup-2.0.0/doc/conf.py" (16 May 2020, 9098 Bytes) of package /linux/www/roundup-2.0.0.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. See also the latest Fossies "Diffs" side-by-side code changes report for "conf.py": 1.6.1_vs_2.0.0.

    1 # -*- coding: utf-8 -*-
    2 
    3 # -- Roundup Notice --
    4 # This conf.py is used to generate local documentation. There is also
    5 # website/www/conf.py in Roundup repository which uses the same .rst
    6 # sources, but different setup to generate site contents.
    7 # ---
    8 
    9 # Roundup documentation build configuration file, created by
   10 # sphinx-quickstart on Tue Jan 20 17:33:20 2009.
   11 #
   12 # This file is execfile()d with the current directory set to its
   13 # containing dir.
   14 #
   15 # Note that not all possible configuration values are present in this
   16 # autogenerated file.
   17 #
   18 # All configuration values have a default; values that are commented out
   19 # serve to show the default.
   20 
   21 import sys
   22 import os
   23 
   24 
   25 # Read Roundup version by importing it from parent directory,
   26 # this ensures that 'unkown version' is inserted even if
   27 # `roundup` is importable from other location in sys.path
   28 SYSSAVE = sys.path
   29 DOCROOT = os.path.abspath(os.path.dirname(__file__))
   30 sys.path = [os.path.dirname(DOCROOT)]
   31 try:
   32     from roundup import __version__ as VERSION
   33     SHORTVER = '.'.join(VERSION.split('.', 2)[:2])
   34 except ImportError:
   35     VERSION = SHORTVER = '(unknown version)'
   36 finally:
   37     sys.path = SYSSAVE
   38 
   39 
   40 # If extensions (or modules to document with autodoc) are in another directory,
   41 # add these directories to sys.path here. If the directory is relative to the
   42 # documentation root, use os.path.abspath to make it absolute, like shown here.
   43 #sys.path.insert(0, os.path.abspath('.'))
   44 
   45 # -- General configuration ------------------------------------------------
   46 
   47 # If your documentation needs a minimal Sphinx version, state it here.
   48 #needs_sphinx = '1.0'
   49 
   50 # Add any Sphinx extension module names here, as strings. They can be
   51 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
   52 # ones.
   53 #extensions = ['toctree']
   54 
   55 # Add any paths that contain templates here, relative to this directory.
   56 templates_path = ['_templates']
   57 
   58 # The suffix(es) of source filenames.
   59 # You can specify multiple suffix as a list of string:
   60 # source_suffix = ['.rst', '.md']
   61 source_suffix = '.txt'
   62 
   63 # The encoding of source files.
   64 #source_encoding = 'utf-8'
   65 
   66 # The master toctree document.
   67 master_doc = 'index'
   68 
   69 # General information about the project.
   70 project = u'Roundup'
   71 copyright = u'2009-2020, Richard Jones, Roundup-Team'
   72 
   73 # The version info for the project you're documenting, acts as replacement for
   74 # |version| and |release|, also used in various other places throughout the
   75 # built documents.
   76 #
   77 # The short X.Y version.
   78 version = SHORTVER
   79 # The full version, including alpha/beta/rc tags.
   80 release = VERSION
   81 
   82 # The language for content autogenerated by Sphinx. Refer to documentation
   83 # for a list of supported languages.
   84 #
   85 # This is also used if you do content translation via gettext catalogs.
   86 # Usually you set "language" from the command line for these cases.
   87 language = None
   88 
   89 # There are two options for replacing |today|: either, you set today to some
   90 # non-false value, then it is used:
   91 #today = ''
   92 # Else, today_fmt is used as the format for a strftime call.
   93 #today_fmt = '%B %d, %Y'
   94 
   95 # List of patterns, relative to source directory, that match files and
   96 # directories to ignore when looking for source files.
   97 # see https://issues.roundup-tracker.org/issue2550907:
   98 exclude_patterns = ['_build',
   99                     'announcement.txt', 'whatsnew-0.7.txt', 'whatsnew-0.8.txt',
  100                     'security.txt' ]
  101 
  102 # The reST default role (used for this markup: `text`) to use for all
  103 # documents.
  104 #default_role = None
  105 
  106 # If true, '()' will be appended to :func: etc. cross-reference text.
  107 #add_function_parentheses = True
  108 
  109 # If true, the current module name will be prepended to all description
  110 # unit titles (such as .. function::).
  111 #add_module_names = True
  112 
  113 # If true, sectionauthor and moduleauthor directives will be shown in the
  114 # output. They are ignored by default.
  115 #show_authors = False
  116 
  117 # The name of the Pygments (syntax highlighting) style to use.
  118 pygments_style = 'sphinx'
  119 
  120 # A list of ignored prefixes for module index sorting.
  121 #modindex_common_prefix = []
  122 
  123 # If true, keep warnings as "system message" paragraphs in the built documents.
  124 #keep_warnings = False
  125 
  126 # -- Options for HTML output ----------------------------------------------
  127 
  128 #-- pre Sphinx 1.3
  129 # The style sheet to use for HTML and HTML Help pages. A file of that name
  130 # must exist either in Sphinx' static/ path, or in one of the custom paths
  131 # given in html_static_path.
  132 html_style = 'style.css'
  133 
  134 #-- Sphinx 1.3
  135 # The theme to use for HTML and HTML Help pages.  See the documentation for
  136 # a list of builtin themes.
  137 #html_theme = 'alabaster'
  138 
  139 # Theme options are theme-specific and customize the look and feel of a theme
  140 # further.  For a list of options available for each theme, see the
  141 # documentation.
  142 #html_theme_options = {}
  143 
  144 # Add any paths that contain custom themes here, relative to this directory.
  145 #html_theme_path = []
  146 
  147 # The name for this set of Sphinx documents.  If None, it defaults to
  148 # "<project> v<release> documentation".
  149 #html_title = None
  150 
  151 # A shorter title for the navigation bar.  Default is the same as html_title.
  152 #html_short_title = None
  153 
  154 # The name of an image file (relative to this directory) to place at the top
  155 # of the sidebar.
  156 #html_logo = None
  157 
  158 # The name of an image file (within the static path) to use as favicon of the
  159 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
  160 # pixels large.
  161 #html_favicon = None
  162 
  163 # Add any paths that contain custom static files (such as style sheets) here,
  164 # relative to this directory. They are copied after the builtin static files,
  165 # so a file named "default.css" will overwrite the builtin "default.css".
  166 html_static_path = ['_static']
  167 
  168 # Add any extra paths that contain custom files (such as robots.txt or
  169 # .htaccess) here, relative to this directory. These files are copied
  170 # directly to the root of the documentation.
  171 html_extra_path = ['html_extra']
  172 
  173 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  174 # using the given strftime format.
  175 html_last_updated_fmt = '%b %d, %Y'
  176 
  177 # If true, SmartyPants will be used to convert quotes and dashes to
  178 # typographically correct entities.
  179 #html_use_smartypants = True
  180 
  181 # Custom sidebar templates, maps document names to template names.
  182 #html_sidebars = {}
  183 
  184 # Additional templates that should be rendered to pages, maps page names to
  185 # template names.
  186 #html_additional_pages = {}
  187 
  188 # If false, no module index is generated.
  189 #html_domain_indices = True
  190 
  191 # If false, no index is generated.
  192 #html_use_index = True
  193 
  194 # If true, the index is split into individual pages for each letter.
  195 #html_split_index = False
  196 
  197 # If true, links to the reST sources are added to the pages.
  198 #html_show_sourcelink = True
  199 
  200 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  201 #html_show_sphinx = True
  202 
  203 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  204 #html_show_copyright = True
  205 
  206 # If true, an OpenSearch description file will be output, and all pages will
  207 # contain a <link> tag referring to it.  The value of this option must be the
  208 # base URL from which the finished HTML is served.
  209 #html_use_opensearch = ''
  210 
  211 # This is the file name suffix for HTML files (e.g. ".xhtml").
  212 #html_file_suffix = None
  213 
  214 # Language to be used for generating the HTML full-text search index.
  215 # Sphinx supports the following languages:
  216 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
  217 #   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
  218 #html_search_language = 'en'
  219 
  220 # A dictionary with options for the search language support, empty by default.
  221 # Now only 'ja' uses this config value
  222 #html_search_options = {'type': 'default'}
  223 
  224 # The name of a javascript file (relative to the configuration directory) that
  225 # implements a search results scorer. If empty, the default will be used.
  226 #html_search_scorer = 'scorer.js'
  227 
  228 # Output file base name for HTML help builder.
  229 htmlhelp_basename = 'roundupdoc'
  230 
  231 # -- Options for LaTeX output ---------------------------------------------
  232 
  233 latex_elements = {
  234 # The paper size ('letterpaper' or 'a4paper').
  235 #'papersize': 'letterpaper',
  236 
  237 # The font size ('10pt', '11pt' or '12pt').
  238 #'pointsize': '10pt',
  239 
  240 # Additional stuff for the LaTeX preamble.
  241 #'preamble': '',
  242 
  243 # Latex figure (float) alignment
  244 #'figure_align': 'htbp',
  245 }
  246 
  247 # Grouping the document tree into LaTeX files. List of tuples
  248 # (source start file, target name, title,
  249 #  author, documentclass [howto, manual, or own class]).
  250 latex_documents = [
  251   ('docs/index', 'Roundup.tex', u'Roundup Documentation',
  252    u'Richard Jones', 'manual'),
  253 ]
  254 
  255 # The name of an image file (relative to this directory) to place at the top of
  256 # the title page.
  257 #latex_logo = None
  258 
  259 # For "manual" documents, if this is true, then toplevel headings are parts,
  260 # not chapters.
  261 #latex_use_parts = False
  262 
  263 # If true, show page references after internal links.
  264 #latex_show_pagerefs = False
  265 
  266 # If true, show URL addresses after external links.
  267 #latex_show_urls = False
  268 
  269 # Documents to append as an appendix to all manuals.
  270 #latex_appendices = []
  271 
  272 # If false, no module index is generated.
  273 #latex_domain_indices = True