lpschedule-generator

libreplanet schedule generator - ricketyspace.net/lpschedule-generator
git clone git://git.ricketyspace.net/lpschedule-generator.git
Log | Files | Refs

conf.py (10093B)


      1 # -*- coding: utf-8 -*-
      2 #
      3 # lpschedule-generator documentation build configuration file, created by
      4 # sphinx-quickstart on Wed May 11 19:54:18 2016.
      5 #
      6 # This file is execfile()d with the current directory set to its
      7 # 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 import sys
     16 import os
     17 
     18 from lpschedule_generator._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.insert(0, os.path.abspath('.'))
     24 
     25 # -- General configuration ------------------------------------------------
     26 
     27 # If your documentation needs a minimal Sphinx version, state it here.
     28 #needs_sphinx = '1.0'
     29 
     30 # Add any Sphinx extension module names here, as strings. They can be
     31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
     32 # ones.
     33 extensions = [
     34     'sphinx.ext.autodoc',
     35     'sphinx.ext.doctest',
     36     'sphinx.ext.intersphinx',
     37     'sphinx.ext.coverage',
     38     'sphinx.ext.viewcode',
     39 ]
     40 
     41 # Add any paths that contain templates here, relative to this directory.
     42 templates_path = ['_templates']
     43 
     44 # The suffix(es) of source filenames.
     45 # You can specify multiple suffix as a list of string:
     46 # source_suffix = ['.rst', '.md']
     47 source_suffix = '.rst'
     48 
     49 # The encoding of source files.
     50 #source_encoding = 'utf-8-sig'
     51 
     52 # The master toctree document.
     53 master_doc = 'index'
     54 
     55 # General information about the project.
     56 project = 'lpschedule-generator'
     57 copyright = 'Public Domain'
     58 author = 'lpschedule-generator contributors'
     59 
     60 # The version info for the project you're documenting, acts as replacement for
     61 # |version| and |release|, also used in various other places throughout the
     62 # built documents.
     63 #
     64 # The short X.Y version.
     65 version = __version__
     66 # The full version, including alpha/beta/rc tags.
     67 release = __version__
     68 
     69 # The language for content autogenerated by Sphinx. Refer to documentation
     70 # for a list of supported languages.
     71 #
     72 # This is also used if you do content translation via gettext catalogs.
     73 # Usually you set "language" from the command line for these cases.
     74 language = None
     75 
     76 # There are two options for replacing |today|: either, you set today to some
     77 # non-false value, then it is used:
     78 #today = ''
     79 # Else, today_fmt is used as the format for a strftime call.
     80 #today_fmt = '%B %d, %Y'
     81 
     82 # List of patterns, relative to source directory, that match files and
     83 # directories to ignore when looking for source files.
     84 # This patterns also effect to html_static_path and html_extra_path
     85 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
     86 
     87 # The reST default role (used for this markup: `text`) to use for all
     88 # documents.
     89 #default_role = None
     90 
     91 # If true, '()' will be appended to :func: etc. cross-reference text.
     92 #add_function_parentheses = True
     93 
     94 # If true, the current module name will be prepended to all description
     95 # unit titles (such as .. function::).
     96 #add_module_names = True
     97 
     98 # If true, sectionauthor and moduleauthor directives will be shown in the
     99 # output. They are ignored by default.
    100 #show_authors = False
    101 
    102 # The name of the Pygments (syntax highlighting) style to use.
    103 pygments_style = 'sphinx'
    104 
    105 # A list of ignored prefixes for module index sorting.
    106 #modindex_common_prefix = []
    107 
    108 # If true, keep warnings as "system message" paragraphs in the built documents.
    109 #keep_warnings = False
    110 
    111 # If true, `todo` and `todoList` produce output, else they produce nothing.
    112 todo_include_todos = False
    113 
    114 
    115 # -- Options for HTML output ----------------------------------------------
    116 
    117 # The theme to use for HTML and HTML Help pages.  See the documentation for
    118 # a list of builtin themes.
    119 html_theme = 'alabaster'
    120 
    121 # Theme options are theme-specific and customize the look and feel of a theme
    122 # further.  For a list of options available for each theme, see the
    123 # documentation.
    124 html_theme_options = {
    125     'show_powered_by': False,
    126     'extra_nav_links': {
    127         'Source': 'https://notabug.org/rsd/lpschedule-generator',
    128         'Report Bugs': 'https://notabug.org/rsd/lpschedule-generator/issues'
    129     }
    130 }
    131 
    132 # Add any paths that contain custom themes here, relative to this directory.
    133 #html_theme_path = []
    134 
    135 # The name for this set of Sphinx documents.
    136 # "<project> v<release> documentation" by default.
    137 #html_title = u'lpschedule-generator v1'
    138 
    139 # A shorter title for the navigation bar.  Default is the same as html_title.
    140 #html_short_title = None
    141 
    142 # The name of an image file (relative to this directory) to place at the top
    143 # of the sidebar.
    144 #html_logo = None
    145 
    146 # The name of an image file (relative to this directory) to use as a favicon of
    147 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
    148 # pixels large.
    149 #html_favicon = None
    150 
    151 # Add any paths that contain custom static files (such as style sheets) here,
    152 # relative to this directory. They are copied after the builtin static files,
    153 # so a file named "default.css" will overwrite the builtin "default.css".
    154 html_static_path = ['_static']
    155 
    156 # Add any extra paths that contain custom files (such as robots.txt or
    157 # .htaccess) here, relative to this directory. These files are copied
    158 # directly to the root of the documentation.
    159 #html_extra_path = []
    160 
    161 # If not None, a 'Last updated on:' timestamp is inserted at every page
    162 # bottom, using the given strftime format.
    163 # The empty string is equivalent to '%b %d, %Y'.
    164 #html_last_updated_fmt = None
    165 
    166 # If true, SmartyPants will be used to convert quotes and dashes to
    167 # typographically correct entities.
    168 #html_use_smartypants = True
    169 
    170 # Custom sidebar templates, maps document names to template names.
    171 html_sidebars = {'**': ['navigation.html']}
    172 
    173 # Additional templates that should be rendered to pages, maps page names to
    174 # template names.
    175 #html_additional_pages = {}
    176 
    177 # If false, no module index is generated.
    178 #html_domain_indices = True
    179 
    180 # If false, no index is generated.
    181 #html_use_index = True
    182 
    183 # If true, the index is split into individual pages for each letter.
    184 #html_split_index = False
    185 
    186 # If true, links to the reST sources are added to the pages.
    187 html_show_sourcelink = False
    188 
    189 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
    190 html_show_sphinx = False
    191 
    192 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
    193 html_show_copyright = False
    194 
    195 # If true, an OpenSearch description file will be output, and all pages will
    196 # contain a <link> tag referring to it.  The value of this option must be the
    197 # base URL from which the finished HTML is served.
    198 #html_use_opensearch = ''
    199 
    200 # This is the file name suffix for HTML files (e.g. ".xhtml").
    201 #html_file_suffix = None
    202 
    203 # Language to be used for generating the HTML full-text search index.
    204 # Sphinx supports the following languages:
    205 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
    206 #   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
    207 #html_search_language = 'en'
    208 
    209 # A dictionary with options for the search language support, empty by default.
    210 # 'ja' uses this config value.
    211 # 'zh' user can custom change `jieba` dictionary path.
    212 #html_search_options = {'type': 'default'}
    213 
    214 # The name of a javascript file (relative to the configuration directory) that
    215 # implements a search results scorer. If empty, the default will be used.
    216 #html_search_scorer = 'scorer.js'
    217 
    218 # Output file base name for HTML help builder.
    219 htmlhelp_basename = 'lpschedule-generatordoc'
    220 
    221 # -- Options for LaTeX output ---------------------------------------------
    222 
    223 latex_elements = {
    224 # The paper size ('letterpaper' or 'a4paper').
    225 #'papersize': 'letterpaper',
    226 
    227 # The font size ('10pt', '11pt' or '12pt').
    228 #'pointsize': '10pt',
    229 
    230 # Additional stuff for the LaTeX preamble.
    231 #'preamble': '',
    232 
    233 # Latex figure (float) alignment
    234 #'figure_align': 'htbp',
    235 }
    236 
    237 # Grouping the document tree into LaTeX files. List of tuples
    238 # (source start file, target name, title,
    239 #  author, documentclass [howto, manual, or own class]).
    240 latex_documents = [
    241     (master_doc, 'lpschedule-generator.tex', 'lpschedule-generator Documentation',
    242      'lpschedule-generator contributors', 'manual'),
    243 ]
    244 
    245 # The name of an image file (relative to this directory) to place at the top of
    246 # the title page.
    247 #latex_logo = None
    248 
    249 # For "manual" documents, if this is true, then toplevel headings are parts,
    250 # not chapters.
    251 #latex_use_parts = False
    252 
    253 # If true, show page references after internal links.
    254 #latex_show_pagerefs = False
    255 
    256 # If true, show URL addresses after external links.
    257 #latex_show_urls = False
    258 
    259 # Documents to append as an appendix to all manuals.
    260 #latex_appendices = []
    261 
    262 # If false, no module index is generated.
    263 #latex_domain_indices = True
    264 
    265 
    266 # -- Options for manual page output ---------------------------------------
    267 
    268 # One entry per manual page. List of tuples
    269 # (source start file, name, description, authors, manual section).
    270 man_pages = [
    271     (master_doc, 'lpschedule-generator', 'lpschedule-generator Documentation',
    272      [author], 1)
    273 ]
    274 
    275 # If true, show URL addresses after external links.
    276 #man_show_urls = False
    277 
    278 
    279 # -- Options for Texinfo output -------------------------------------------
    280 
    281 # Grouping the document tree into Texinfo files. List of tuples
    282 # (source start file, target name, title, author,
    283 #  dir menu entry, description, category)
    284 texinfo_documents = [
    285     (master_doc, 'lpschedule-generator', 'lpschedule-generator Documentation',
    286      author, 'lpschedule-generator', 'One line description of project.',
    287      'Miscellaneous'),
    288 ]
    289 
    290 # Documents to append as an appendix to all manuals.
    291 #texinfo_appendices = []
    292 
    293 # If false, no module index is generated.
    294 #texinfo_domain_indices = True
    295 
    296 # How to display URL addresses: 'footnote', 'no', or 'inline'.
    297 #texinfo_show_urls = 'footnote'
    298 
    299 # If true, do not generate a @detailmenu in the "Top" node's menu.
    300 #texinfo_no_detailmenu = False
    301 
    302 
    303 # Example configuration for intersphinx: refer to the Python standard library.
    304 intersphinx_mapping = {'https://docs.python.org/': None}