"Fossies" - the Fresh Open Source Software Archive

Member "privacyidea-3.6.2/doc/conf.py" (22 Jul 2021, 9550 Bytes) of package /linux/misc/privacyidea-3.6.2.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 latest Fossies "Diffs" side-by-side code changes report: 3.6.1_vs_3.6.2.

    1 # -*- coding: utf-8 -*-
    2 #
    3 # privacyIDEA documentation build configuration file, created by
    4 # sphinx-quickstart on Fri Jun 13 07:31:01 2014.
    5 #
    6 # This file is execfile()d with the current directory set to its containing dir.
    7 #
    8 # Note that not all possible configuration values are present in this
    9 # autogenerated file.
   10 #
   11 # All configuration values have a default; values that are commented out
   12 # serve to show the default.
   13 
   14 import sys
   15 import os
   16 
   17 # Monkey-patch functools.wraps
   18 # http://stackoverflow.com/questions/28366818/preserve-default-arguments-of-wrapped-decorated-python-function-in-sphinx-docume
   19 import functools
   20 
   21 # The version info for the project you're documenting, acts as replacement for
   22 # |version| and |release|, also used in various other places throughout the
   23 # built documents.
   24 #
   25 # The short X.Y version.
   26 version = '3.6.2'
   27 # The full version, including alpha/beta/rc tags.
   28 #release = '2.16dev5'
   29 release = version
   30 
   31 
   32 def no_op_wraps(func, assigned=None, updated=None):
   33     """Replaces functools.wraps in order to undo wrapping.
   34 
   35     Can be used to preserve the decorated function's signature
   36     in the documentation generated by Sphinx.
   37 
   38     """
   39     def wrapper(decorator):
   40         return func
   41     return wrapper
   42 
   43 
   44 functools.wraps = no_op_wraps
   45 
   46 # If extensions (or modules to document with autodoc) are in another directory,
   47 # add these directories to sys.path here. If the directory is relative to the
   48 # documentation root, use os.path.abspath to make it absolute, like shown here.
   49 sys.path.insert(0, os.path.abspath('..'))
   50 sys.path.append(os.path.abspath('_themes/flask-sphinx-themes'))
   51 sys.path.insert(0, os.path.abspath('../privacyidea'))
   52 
   53 # -- General configuration -----------------------------------------------------
   54 
   55 # If your documentation needs a minimal Sphinx version, state it here.
   56 #needs_sphinx = '1.0'
   57 
   58 # Add any Sphinx extension module names here, as strings. They can be extensions
   59 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
   60 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.imgmath', 'sphinx.ext.viewcode', 
   61               'sphinxcontrib.autohttp.flask', 'sphinxcontrib.plantuml',
   62               'sphinxcontrib.spelling', 'sphinx.ext.todo',
   63               'pallets_sphinx_themes']
   64 http_index_ignore_prefixes = ['/token']
   65 
   66 # Add any paths that contain templates here, relative to this directory.
   67 templates_path = ['_templates']
   68 
   69 # The suffix of source filenames.
   70 source_suffix = '.rst'
   71 
   72 # The encoding of source files.
   73 #source_encoding = 'utf-8-sig'
   74 
   75 # The master toctree document.
   76 master_doc = 'index'
   77 
   78 # General information about the project.
   79 project = u'privacyIDEA'
   80 copyright = u'2014-2020, Cornelius Kölbel'
   81 
   82 # The language for content autogenerated by Sphinx. Refer to documentation
   83 # for a list of supported languages.
   84 #language = None
   85 
   86 # There are two options for replacing |today|: either, you set today to some
   87 # non-false value, then it is used:
   88 #today = ''
   89 # Else, today_fmt is used as the format for a strftime call.
   90 #today_fmt = '%B %d, %Y'
   91 
   92 # List of patterns, relative to source directory, that match files and
   93 # directories to ignore when looking for source files.
   94 exclude_patterns = ['_build']
   95 
   96 # The reST default role (used for this markup: `text`) to use for all documents.
   97 #default_role = None
   98 
   99 # If true, '()' will be appended to :func: etc. cross-reference text.
  100 add_function_parentheses = True
  101 
  102 # If true, the current module name will be prepended to all description
  103 # unit titles (such as .. function::).
  104 #add_module_names = True
  105 
  106 # If true, sectionauthor and moduleauthor directives will be shown in the
  107 # output. They are ignored by default.
  108 #show_authors = False
  109 
  110 # The name of the Pygments (syntax highlighting) style to use.
  111 #pygments_style = 'sphinx'
  112 
  113 # A list of ignored prefixes for module index sorting.
  114 #modindex_common_prefix = []
  115 
  116 
  117 # -- Options for HTML output ---------------------------------------------------
  118 
  119 # The theme to use for HTML and HTML Help pages.  See the documentation for
  120 # a list of builtin themes.
  121 #html_theme = 'sphinxdoc'
  122 #html_theme = 'sphinx_rtd_theme'
  123 #html_theme = 'agogo'
  124 html_theme = 'flask'
  125 
  126 # Theme options are theme-specific and customize the look and feel of a theme
  127 # further.  For a list of options available for each theme, see the
  128 # documentation.
  129 #html_theme_options = {}
  130 
  131 # Add any paths that contain custom themes here, relative to this directory.
  132 #html_theme_path = ['_themes/flask-sphinx-themes']
  133 
  134 
  135 # The name for this set of Sphinx documents.  If None, it defaults to
  136 # "<project> v<release> documentation".
  137 #html_title = None
  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 = "images/privacyidea-color.png"
  145 
  146 # The name of an image file (within the static path) to use as favicon of the
  147 # 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 html_css_files = [
  157     'css/custom.css',
  158 ]
  159 
  160 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  161 # using the given strftime format.
  162 #html_last_updated_fmt = '%b %d, %Y'
  163 
  164 # If true, SmartyPants will be used to convert quotes and dashes to
  165 # typographically correct entities.
  166 #html_use_smartypants = True
  167 
  168 # Custom sidebar templates, maps document names to template names.
  169 #html_sidebars = {}
  170 
  171 # Additional templates that should be rendered to pages, maps page names to
  172 # template names.
  173 #html_additional_pages = {}
  174 
  175 # If false, no module index is generated.
  176 #html_domain_indices = True
  177 
  178 # If false, no index is generated.
  179 #html_use_index = True
  180 
  181 # If true, the index is split into individual pages for each letter.
  182 #html_split_index = False
  183 
  184 # If true, links to the reST sources are added to the pages.
  185 #html_show_sourcelink = True
  186 
  187 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  188 #html_show_sphinx = True
  189 
  190 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  191 #html_show_copyright = True
  192 
  193 # If true, an OpenSearch description file will be output, and all pages will
  194 # contain a <link> tag referring to it.  The value of this option must be the
  195 # base URL from which the finished HTML is served.
  196 #html_use_opensearch = ''
  197 
  198 # This is the file name suffix for HTML files (e.g. ".xhtml").
  199 #html_file_suffix = None
  200 
  201 # Output file base name for HTML help builder.
  202 htmlhelp_basename = 'privacyIDEAdoc'
  203 
  204 # Include to do items of sphinx.ext.todo.
  205 # Alternatively, set to true on compiling by
  206 # "sphinx-build -b html -D todo_include_todos=1"
  207 # todo_include_todos = True
  208 
  209 # sphinx spell checking via extension sphinxcontrib.spelling
  210 spelling_lang = 'en_US'
  211 spelling_word_list_filename = ['spelling_wordlist.txt']
  212 
  213 # -- Options for LaTeX output --------------------------------------------------
  214 
  215 latex_elements = {
  216 # The paper size ('letterpaper' or 'a4paper').
  217 #'papersize': 'letterpaper',
  218 
  219 # The font size ('10pt', '11pt' or '12pt').
  220 #'pointsize': '10pt',
  221 
  222 # Additional stuff for the LaTeX preamble.
  223 #'preamble': '',
  224 }
  225 
  226 # Grouping the document tree into LaTeX files. List of tuples
  227 # (source start file, target name, title, author, documentclass [howto/manual]).
  228 latex_documents = [
  229   ('index', 'privacyIDEA.tex', u'privacyIDEA Authentication System',
  230    u'Cornelius Kölbel', 'manual'),
  231 ]
  232 
  233 # The name of an image file (relative to this directory) to place at the top of
  234 # the title page.
  235 #latex_logo = None
  236 
  237 # For "manual" documents, if this is true, then toplevel headings are parts,
  238 # not chapters.
  239 #latex_use_parts = False
  240 
  241 # If true, show page references after internal links.
  242 #latex_show_pagerefs = False
  243 
  244 # If true, show URL addresses after external links.
  245 #latex_show_urls = False
  246 
  247 # Documents to append as an appendix to all manuals.
  248 #latex_appendices = []
  249 
  250 # If false, no module index is generated.
  251 #latex_domain_indices = True
  252 
  253 
  254 # -- Options for manual page output --------------------------------------------
  255 
  256 # One entry per manual page. List of tuples
  257 # (source start file, name, description, authors, manual section).
  258 man_pages = [
  259     ('index', 'privacyidea-server', u'privacyIDEA Authentication System',
  260      [u'Cornelius Kölbel'], 1)
  261 ]
  262 
  263 # If true, show URL addresses after external links.
  264 #man_show_urls = False
  265 
  266 
  267 # -- Options for Texinfo output ------------------------------------------------
  268 
  269 # Grouping the document tree into Texinfo files. List of tuples
  270 # (source start file, target name, title, author,
  271 #  dir menu entry, description, category)
  272 texinfo_documents = [
  273   ('index', 'privacyIDEA', u'privacyIDEA AUthentication System',
  274    u'Cornelius Kölbel', 'privacyIDEA', 'One line description of project.',
  275    'Miscellaneous'),
  276 ]
  277 
  278 # Documents to append as an appendix to all manuals.
  279 #texinfo_appendices = []
  280 
  281 # If false, no module index is generated.
  282 #texinfo_domain_indices = True
  283 
  284 # How to display URL addresses: 'footnote', 'no', or 'inline'.
  285 #texinfo_show_urls = 'footnote'
  286 
  287 #
  288 # PlantUML
  289 #
  290 
  291 # Run plantUML under Java in headless mode. This is needed for compatibility with readthedocs.io.
  292 plantuml = 'java -Djava.awt.headless=true -jar /usr/share/plantuml/plantuml.jar'
  293 
  294 # Use SVG inside <object> in supported browsers (all except IE8), falling back to PNG.
  295 plantuml_output_format = 'svg'