taldir

Directory service to resolve wallet mailboxes by messenger addresses
Log | Files | Refs | Submodules | README | LICENSE

conf.py (8903B)


      1 """
      2   This file is part of GNU TALER.
      3   Copyright (C) 2014-2020 Taler Systems SA
      4 
      5   TALER is free software; you can redistribute it and/or modify it under the
      6   terms of the GNU Lesser General Public License as published by the Free Software
      7   Foundation; either version 2.1, or (at your option) any later version.
      8 
      9   TALER is distributed in the hope that it will be useful, but WITHOUT ANY
     10   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
     11   A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
     12 
     13   You should have received a copy of the GNU Lesser General Public License along with
     14   TALER; see the file COPYING.  If not, see <http://www.gnu.org/licenses/>
     15 
     16   @author Florian Dold
     17   @author Benedikt Muller
     18   @author Sree Harsha Totakura
     19   @author Marcello Stanisci
     20   @author Martin Schanzenbach
     21 """
     22 # -*- coding: utf-8 -*-
     23 #
     24 # neuro documentation build configuration file, created by
     25 # sphinx-quickstart on Sat May 31 13:11:06 2014.
     26 #
     27 # This file is execfile()d with the current directory set to its
     28 # containing dir.
     29 #
     30 # Note that not all possible configuration values are present in this
     31 # autogenerated file.
     32 #
     33 # All configuration values have a default; values that are commented out
     34 # serve to show the default.
     35 
     36 import sys
     37 import os
     38 
     39 sys.path.append(os.path.abspath('_exts'))
     40 
     41 #import taler_sphinx_theme
     42 
     43 # If extensions (or modules to document with autodoc) are in another directory,
     44 # add these directories to sys.path here. If the directory is relative to the
     45 # documentation root, use os.path.abspath to make it absolute, like shown here.
     46 #sys.path.insert(0, os.path.abspath('.'))
     47 
     48 # -- General configuration ------------------------------------------------
     49 
     50 # If your documentation needs a minimal Sphinx version, state it here.
     51 needs_sphinx = '1.8.5'
     52 
     53 # Add any Sphinx extension module names here, as strings. They can be
     54 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
     55 # ones.
     56 extensions = [
     57     'sphinx.ext.todo',
     58     'sphinx.ext.imgmath',
     59 ]
     60 
     61 # Add any paths that contain templates here, relative to this directory.
     62 templates_path = ['_templates']
     63 
     64 source_suffix = {
     65     '.rst': 'restructuredtext',
     66 }
     67 
     68 # The encoding of source files.
     69 #source_encoding = 'utf-8-sig'
     70 
     71 # The master toctree document.
     72 master_doc = 'pp'
     73 
     74 # General information about the project.
     75 project = u'pp'
     76 copyright = u'2014-2020 Taler Systems SA (GPLv3+ or GFDL 1.3+)'
     77 
     78 # The version info for the project you're documenting, acts as replacement for
     79 # |version| and |release|, also used in various other places throughout the
     80 # built documents.
     81 #
     82 # The short X.Y version.
     83 version = '0'
     84 # The full version, including alpha/beta/rc tags.
     85 release = '0'
     86 
     87 # The language for content autogenerated by Sphinx. Refer to documentation
     88 # for a list of supported languages.
     89 # language = "en de"
     90 
     91 # There are two options for replacing |today|: either, you set today to some
     92 # non-false value, then it is used:
     93 #today = ''
     94 # Else, today_fmt is used as the format for a strftime call.
     95 #today_fmt = '%B %d, %Y'
     96 
     97 # List of patterns, relative to source directory, that match files and
     98 # directories to ignore when looking for source files.
     99 exclude_patterns = ['_build', '_exts', 'cf', 'prebuilt']
    100 
    101 # The reST default role (used for this markup: `text`) to use for all
    102 # documents.
    103 # default_role = "ts:type"
    104 
    105 locale_dirs = ['locale/']
    106 gettext_compact = False
    107 
    108 # If true, '()' will be appended to :func: etc. cross-reference text.
    109 #add_function_parentheses = True
    110 
    111 # If true, the current module name will be prepended to all description
    112 # unit titles (such as .. function::).
    113 #add_module_names = True
    114 
    115 # If true, sectionauthor and moduleauthor directives will be shown in the
    116 # output. They are ignored by default.
    117 #show_authors = False
    118 
    119 # The name of the Pygments (syntax highlighting) style to use.
    120 pygments_style = 'sphinx'
    121 
    122 # A list of ignored prefixes for module index sorting.
    123 #modindex_common_prefix = []
    124 
    125 # If true, keep warnings as "system message" paragraphs in the built documents.
    126 #keep_warnings = False
    127 
    128 # -- Options for HTML output ----------------------------------------------
    129 
    130 # The theme to use for HTML and HTML Help pages.  See the documentation for
    131 # a list of builtin themes.
    132 html_theme = 'epub'
    133 
    134 #html_theme_path = taler_sphinx_theme.html_theme_path()
    135 
    136 #html_sidebars = {'**': ['logo-text.html', 'globaltoc.html', 'searchbox.html']}
    137 
    138 rst_epilog = ""
    139 
    140 html_show_sphinx = False
    141 
    142 html_theme_options = {
    143     # Set the name of the project to appear in the sidebar
    144     "relbar1": "false",
    145     "footer": "false",
    146 }
    147 
    148 # Add any paths that contain custom themes here, relative to this directory.
    149 #html_theme_path = []
    150 
    151 # The name for this set of Sphinx documents.  If None, it defaults to
    152 # "<project> v<release> documentation".
    153 html_title = "TalDir Privacy Policy"
    154 
    155 # A shorter title for the navigation bar.  Default is the same as html_title.
    156 html_short_title = "Privacy Policy"
    157 
    158 # The name of an image file (relative to this directory) to place at the top
    159 # of the sidebar.
    160 #html_logo = None
    161 
    162 # The name of an image file (within the static path) to use as favicon of the
    163 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
    164 # pixels large.
    165 #html_favicon = None
    166 
    167 # Add any paths that contain custom static files (such as style sheets) here,
    168 # relative to this directory. They are copied after the builtin static files,
    169 # so a file named "default.css" will overwrite the builtin "default.css".
    170 # html_static_path = ['_static']
    171 
    172 # Add any extra paths that contain custom files (such as robots.txt or
    173 # .htaccess) here, relative to this directory. These files are copied
    174 # directly to the root of the documentation.
    175 #html_extra_path = []
    176 
    177 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
    178 # using the given strftime format.
    179 #html_last_updated_fmt = '%b %d, %Y'
    180 
    181 # If true, SmartyPants will be used to convert quotes and dashes to
    182 # typographically correct entities.
    183 #html_use_smartypants = True
    184 
    185 # Custom sidebar templates, maps document names to template names.
    186 #html_sidebars = {}
    187 
    188 # Additional templates that should be rendered to pages, maps page names to
    189 # template names.
    190 #html_additional_pages = {}
    191 
    192 # If false, no module index is generated.
    193 #html_domain_indices = True
    194 
    195 # If false, no index is generated.
    196 #html_use_index = True
    197 
    198 # If true, the index is split into individual pages for each letter.
    199 #html_split_index = False
    200 
    201 # If true, links to the reST sources are added to the pages.
    202 #html_show_sourcelink = True
    203 
    204 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
    205 html_show_sphinx = False
    206 
    207 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
    208 #html_show_copyright = True
    209 
    210 # If true, an OpenSearch description file will be output, and all pages will
    211 # contain a <link> tag referring to it.  The value of this option must be the
    212 # base URL from which the finished HTML is served.
    213 #html_use_opensearch = ''
    214 
    215 # This is the file name suffix for HTML files (e.g. ".xhtml").
    216 #html_file_suffix = None
    217 
    218 # -- Options for LaTeX output ---------------------------------------------
    219 
    220 latex_elements = {
    221     # The paper size ('letterpaper' or 'a4paper').
    222     #'papersize': 'letterpaper',
    223 
    224     # The font size ('10pt', '11pt' or '12pt').
    225     #'pointsize': '10pt',
    226 
    227     # Additional stuff for the LaTeX preamble.
    228     #'preamble': '',
    229 }
    230 
    231 # Grouping the document tree into LaTeX files. List of tuples
    232 # (source start file, target name, title,
    233 #  author, documentclass [howto, manual, or own class]).
    234 latex_documents = [
    235     ('pp', 'pp.tex',
    236      'Privacy Policy', 'GNUnet e.V. team', 'manual'),
    237 ]
    238 
    239 # The name of an image file (relative to this directory) to place at the top of
    240 # the title page.
    241 #latex_logo = None
    242 
    243 # For "manual" documents, if this is true, then toplevel headings are parts,
    244 # not chapters.
    245 #latex_use_parts = False
    246 
    247 # If true, show page references after internal links.
    248 #latex_show_pagerefs = False
    249 
    250 # If true, show URL addresses after external links.
    251 #latex_show_urls = False
    252 
    253 # Documents to append as an appendix to all manuals.
    254 # latex_appendices = ["fdl-1.3"]
    255 
    256 # If false, no module index is generated.
    257 #latex_domain_indices = True
    258 
    259 # -- Options for manual page output ---------------------------------------
    260 
    261 # If true, show URL addresses after external links.
    262 #man_show_urls = False
    263 
    264 # -- Options for Texinfo output -------------------------------------------
    265 
    266 # Documents to append as an appendix to all manuals.
    267 #texinfo_appendices = []
    268 
    269 # If false, no module index is generated.
    270 #texinfo_domain_indices = True
    271 
    272 # How to display URL addresses: 'footnote', 'no', or 'inline'.
    273 #texinfo_show_urls = 'footnote'
    274 
    275 # If true, do not generate a @detailmenu in the "Top" node's menu.
    276 #texinfo_no_detailmenu = False
    277 
    278 
    279 # -- Options for epub output  ----------------------------
    280 
    281 epub_basename = "pp"
    282 
    283 epub_title = "Privacy Policy"