"Fossies" - the Fresh Open Source Software Archive

Member "buku-4.4/docs/source/conf.py" (15 Jun 2020, 5454 Bytes) of package /linux/privat/buku-4.4.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: 4.2.2_vs_4.3.

    1 #!/usr/bin/env python3
    2 # -*- coding: utf-8 -*-
    3 #
    4 # buku documentation build configuration file, created by
    5 # sphinx-quickstart on Thu Sep  7 12:54:59 2017.
    6 #
    7 # This file is execfile()d with the current directory set to its
    8 # containing dir.
    9 #
   10 # Note that not all possible configuration values are present in this
   11 # autogenerated file.
   12 #
   13 # All configuration values have a default; values that are commented out
   14 # serve to show the default.
   15 
   16 # If extensions (or modules to document with autodoc) are in another directory,
   17 # add these directories to sys.path here. If the directory is relative to the
   18 # documentation root, use os.path.abspath to make it absolute, like shown here.
   19 #
   20 import os
   21 import sys
   22 from recommonmark.parser import CommonMarkParser
   23 sys.path.insert(0, os.path.abspath('../../'))
   24 # sys.path.insert(0, os.path.abspath('../'))
   25 
   26 
   27 # -- General configuration ------------------------------------------------
   28 
   29 # If your documentation needs a minimal Sphinx version, state it here.
   30 #
   31 # needs_sphinx = '1.0'
   32 
   33 # Add any Sphinx extension module names here, as strings. They can be
   34 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
   35 # ones.
   36 extensions = ['sphinx.ext.autodoc',
   37               'sphinx.ext.viewcode',
   38               'sphinx.ext.autosummary',
   39               'sphinx.ext.napoleon']
   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 #
   47 source_parsers = {'.md': CommonMarkParser}
   48 source_suffix = ['.rst', '.md']
   49 # source_suffix = '.rst'
   50 
   51 # The master toctree document.
   52 master_doc = 'index'
   53 
   54 # General information about the project.
   55 project = 'buku'
   56 copyright = '2018, Arun Prakash Jana'
   57 author = 'Arun Prakash Jana'
   58 
   59 # The version info for the project you're documenting, acts as replacement for
   60 # |version| and |release|, also used in various other places throughout the
   61 # built documents.
   62 #
   63 # The short X.Y version.
   64 version = ''
   65 # The full version, including alpha/beta/rc tags.
   66 release = ''
   67 
   68 # The language for content autogenerated by Sphinx. Refer to documentation
   69 # for a list of supported languages.
   70 #
   71 # This is also used if you do content translation via gettext catalogs.
   72 # Usually you set "language" from the command line for these cases.
   73 language = None
   74 
   75 # List of patterns, relative to source directory, that match files and
   76 # directories to ignore when looking for source files.
   77 # This patterns also effect to html_static_path and html_extra_path
   78 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
   79 
   80 # The name of the Pygments (syntax highlighting) style to use.
   81 pygments_style = 'sphinx'
   82 
   83 # If true, `todo` and `todoList` produce output, else they produce nothing.
   84 todo_include_todos = False
   85 
   86 
   87 # -- Options for HTML output ----------------------------------------------
   88 
   89 # The theme to use for HTML and HTML Help pages.  See the documentation for
   90 # a list of builtin themes.
   91 #
   92 # html_theme = 'alabaster'
   93 html_theme = "sphinx_rtd_theme"
   94 
   95 # Theme options are theme-specific and customize the look and feel of a theme
   96 # further.  For a list of options available for each theme, see the
   97 # documentation.
   98 #
   99 # html_theme_options = {}
  100 
  101 # Add any paths that contain custom static files (such as style sheets) here,
  102 # relative to this directory. They are copied after the builtin static files,
  103 # so a file named "default.css" will overwrite the builtin "default.css".
  104 # html_static_path = ['_static']
  105 html_static_path = []
  106 
  107 # Custom sidebar templates, must be a dictionary that maps document names
  108 # to template names.
  109 #
  110 # This is required for the alabaster theme
  111 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
  112 html_sidebars = {
  113     '**': [
  114         'about.html',
  115         'navigation.html',
  116         'relations.html',  # needs 'show_related': True theme option to display
  117         'searchbox.html',
  118         'donate.html',
  119     ]
  120 }
  121 
  122 
  123 # -- Options for HTMLHelp output ------------------------------------------
  124 
  125 # Output file base name for HTML help builder.
  126 htmlhelp_basename = 'bukudoc'
  127 
  128 
  129 # -- Options for LaTeX output ---------------------------------------------
  130 
  131 latex_elements = {
  132     # The paper size ('letterpaper' or 'a4paper').
  133     #
  134     # 'papersize': 'letterpaper',
  135 
  136     # The font size ('10pt', '11pt' or '12pt').
  137     #
  138     # 'pointsize': '10pt',
  139 
  140     # Additional stuff for the LaTeX preamble.
  141     #
  142     # 'preamble': '',
  143 
  144     # Latex figure (float) alignment
  145     #
  146     # 'figure_align': 'htbp',
  147 }
  148 
  149 # Grouping the document tree into LaTeX files. List of tuples
  150 # (source start file, target name, title,
  151 #  author, documentclass [howto, manual, or own class]).
  152 latex_documents = [
  153     (master_doc, 'buku.tex', 'buku documentation',
  154      'Arun Prakash Jana', 'manual'),
  155 ]
  156 
  157 
  158 # -- Options for manual page output ---------------------------------------
  159 
  160 # One entry per manual page. List of tuples
  161 # (source start file, name, description, authors, manual section).
  162 man_pages = [
  163     (master_doc, 'buku', 'buku documentation',
  164      [author], 1)
  165 ]
  166 
  167 
  168 # -- Options for Texinfo output -------------------------------------------
  169 
  170 # Grouping the document tree into Texinfo files. List of tuples
  171 # (source start file, target name, title, author,
  172 #  dir menu entry, description, category)
  173 texinfo_documents = [
  174     (master_doc, 'buku', 'buku documentation',
  175      author, 'buku', 'One line description of project.',
  176      'Miscellaneous'),
  177 ]