taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

conf.py (34467B)


      1 """
      2   This file is part of GNU TALER.
      3   Copyright (C) 2014-2023 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 Christian Grothoff
     21   @author Özgür Kesim
     22 """
     23 # -*- coding: utf-8 -*-
     24 #
     25 # neuro documentation build configuration file, created by
     26 # sphinx-quickstart on Sat May 31 13:11:06 2014.
     27 #
     28 # This file is execfile()d with the current directory set to its
     29 # containing dir.
     30 #
     31 # Note that not all possible configuration values are present in this
     32 # autogenerated file.
     33 #
     34 # All configuration values have a default; values that are commented out
     35 # serve to show the default.
     36 
     37 import sys
     38 import os
     39 
     40 sys.path.append(os.path.abspath("_exts"))
     41 
     42 # If extensions (or modules to document with autodoc) are in another directory,
     43 # add these directories to sys.path here. If the directory is relative to the
     44 # documentation root, use os.path.abspath to make it absolute, like shown here.
     45 # sys.path.insert(0, os.path.abspath('.'))
     46 
     47 # -- General configuration ------------------------------------------------
     48 
     49 # If your documentation needs a minimal Sphinx version, state it here.
     50 needs_sphinx = "8.0.0"
     51 
     52 # Add any Sphinx extension module names here, as strings. They can be
     53 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
     54 # ones.
     55 extensions = [
     56     "ebicsdomain",
     57     "typescriptdomain",
     58     "sphinx.ext.todo",
     59     "sphinx.ext.graphviz",
     60     "sphinx.ext.imgmath",
     61     "sphinxcontrib.plantuml",
     62     "httpdomain.httpdomain",
     63     "myst_parser",
     64     "sphinx_multitoc_numbering",
     65     "sphinx_design",
     66 ]
     67 
     68 imgmath_image_format = 'svg'
     69 imgmath_use_preview = True
     70 
     71 # PlantUML diagrams (``.. uml::``), rendered at build time. Needs a
     72 # ``plantuml`` command on PATH, provided by the Nix development shell
     73 # and package.
     74 plantuml = os.environ.get("PLANTUML", "plantuml")
     75 plantuml_output_format = "svg"
     76 
     77 # Add any paths that contain templates here, relative to this directory.
     78 templates_path = ["_templates"]
     79 
     80 source_suffix = {
     81     ".rst": "restructuredtext",
     82     ".txt": "markdown",
     83     ".md": "markdown",
     84 }
     85 
     86 # The encoding of source files.
     87 # source_encoding = 'utf-8-sig'
     88 
     89 # The master toctree document.
     90 master_doc = "index"
     91 
     92 # General information about the project.
     93 project = "GNU Taler"
     94 copyright = "2014-2025 Taler Systems SA (GPLv3+ or GFDL 1.3+)"
     95 
     96 # The version info for the project you're documenting, acts as replacement for
     97 # |version| and |release|, also used in various other places throughout the
     98 # built documents.
     99 #
    100 # The short X.Y version.
    101 version = "1.0"
    102 # The full version, including alpha/beta/rc tags.
    103 release = "1.0.0"
    104 
    105 # The language for content autogenerated by Sphinx. Refer to documentation
    106 # for a list of supported languages.
    107 # language = None
    108 
    109 # There are two options for replacing |today|: either, you set today to some
    110 # non-false value, then it is used:
    111 # today = ''
    112 # Else, today_fmt is used as the format for a strftime call.
    113 # today_fmt = '%B %d, %Y'
    114 
    115 # List of patterns, relative to source directory, that match files and
    116 # directories to ignore when looking for source files.
    117 exclude_patterns = [
    118     "_build",
    119     "_exts",
    120     ".*",
    121     "cf",
    122     "prebuilt",
    123     "**/README.md",
    124     "extract-tsdefs",
    125     "frags",
    126     "orphaned",
    127 ]
    128 
    129 # The reST default role (used for this markup: `text`) to use for all
    130 # documents.
    131 default_role = "ts:type"
    132 
    133 # If true, '()' will be appended to :func: etc. cross-reference text.
    134 # add_function_parentheses = True
    135 
    136 # If true, the current module name will be prepended to all description
    137 # unit titles (such as .. function::).
    138 # add_module_names = True
    139 
    140 # If true, sectionauthor and moduleauthor directives will be shown in the
    141 # output. They are ignored by default.
    142 show_authors = False
    143 author = 'GNU Taler Developers'
    144 
    145 # The name of the Pygments (syntax highlighting) style to use.
    146 pygments_style = "sphinx"
    147 
    148 # A list of ignored prefixes for module index sorting.
    149 # modindex_common_prefix = []
    150 
    151 # If true, keep warnings as "system message" paragraphs in the built documents.
    152 # keep_warnings = False
    153 
    154 # -- Options for HTML output ----------------------------------------------
    155 
    156 # The theme to use for HTML and HTML Help pages.  See the documentation for
    157 # a list of builtin themes.
    158 html_theme = "sphinx_book_theme"
    159 
    160 #html_sidebars = {"**": ["logo-text.html", "globaltoc.html", "searchbox.html"]}
    161 #html_sidebars = {"**": ["globaltoc.html", "searchbox.html"]}
    162 
    163 html_theme_options = {
    164     # Set the name of the project to appear in the sidebar
    165     "home_page_in_toc": True,
    166     "logo": {
    167         "alt_text": "GNU Taler",
    168         "image_light": "images/taler-logo.svg",
    169         "image_dark": "images/taler-logo-white.svg",
    170     },
    171     "show_navbar_depth": 1,
    172     "show_toc_level": 2,
    173     "use_fullscreen_button": False,
    174     "use_download_button": False,
    175     "extra_footer": "<div>Do you have any question or suggestion regarding the documentation?  Go to our <a href='https://ich.taler.net/t/lost-in-documentation/255'>TALER Integration Community Hub</a>!</div>",
    176 }
    177 
    178 # Add any paths that contain custom themes here, relative to this directory.
    179 # html_theme_path = []
    180 
    181 # The name for this set of Sphinx documents.  If None, it defaults to
    182 # "<project> v<release> documentation".
    183 html_title = "GNU Taler"
    184 
    185 # A shorter title for the navigation bar.  Default is the same as html_title.
    186 html_short_title = "GNU Taler"
    187 
    188 # The name of an image file (relative to this directory) to place at the top
    189 # of the sidebar.
    190 # html_logo = "images/taler-logo.svg"
    191 
    192 # The name of an image file (within the static path) to use as favicon of the
    193 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
    194 # pixels large.
    195 # html_favicon = None
    196 
    197 # Add any paths that contain custom static files (such as style sheets) here,
    198 # relative to this directory. They are copied after the builtin static files,
    199 # so a file named "default.css" will overwrite the builtin "default.css".
    200 html_static_path = ["_static"]
    201 
    202 # This is a sphinx-book-themes specific parameter to allow for customized css
    203 html_css_files = ["custom.css"]
    204 
    205 # Add any extra paths that contain custom files (such as robots.txt or
    206 # .htaccess) here, relative to this directory. These files are copied
    207 # directly to the root of the documentation.
    208 # html_extra_path = []
    209 
    210 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
    211 # using the given strftime format.
    212 # html_last_updated_fmt = '%b %d, %Y'
    213 
    214 # If true, SmartyPants will be used to convert quotes and dashes to
    215 # typographically correct entities.
    216 # html_use_smartypants = True
    217 
    218 # Custom sidebar templates, maps document names to template names.
    219 # html_sidebars = {}
    220 
    221 # Additional templates that should be rendered to pages, maps page names to
    222 # template names.
    223 # html_additional_pages = {}
    224 
    225 # If false, no module index is generated.
    226 # html_domain_indices = True
    227 
    228 # If false, no index is generated.
    229 # html_use_index = True
    230 
    231 # If true, the index is split into individual pages for each letter.
    232 # html_split_index = False
    233 
    234 # If true, links to the reST sources are added to the pages.
    235 # html_show_sourcelink = True
    236 
    237 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
    238 html_show_sphinx = False
    239 
    240 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
    241 # html_show_copyright = True
    242 
    243 # If true, an OpenSearch description file will be output, and all pages will
    244 # contain a <link> tag referring to it.  The value of this option must be the
    245 # base URL from which the finished HTML is served.
    246 # html_use_opensearch = ''
    247 
    248 # This is the file name suffix for HTML files (e.g. ".xhtml").
    249 # html_file_suffix = None
    250 
    251 # -- Options for LaTeX output ---------------------------------------------
    252 
    253 latex_elements = {
    254     # The paper size ('letterpaper' or 'a4paper').
    255     #'papersize': 'letterpaper',
    256     # The font size ('10pt', '11pt' or '12pt').
    257     #'pointsize': '10pt',
    258     # Additional stuff for the LaTeX preamble.
    259     #'preamble': '',
    260 }
    261 
    262 # Grouping the document tree into LaTeX files. List of tuples
    263 # (source start file, target name, title,
    264 #  author, documentclass [howto, manual, or own class]).
    265 latex_documents = [
    266     (
    267         "taler-auditor-manual",
    268         "taler-auditor-manual.tex",
    269         "GNU Taler Auditor Manual",
    270         "GNU Taler team",
    271         "manual",
    272     ),
    273     (
    274         "taler-exchange-manual",
    275         "taler-exchange-manual.tex",
    276         "GNU Taler Exchange Manual",
    277         "GNU Taler team",
    278         "manual",
    279     ),
    280     (
    281         "taler-challenger-manual",
    282         "taler-challenger-manual.tex",
    283         "GNU Taler Challenger Manual",
    284         "GNU Taler team",
    285         "manual",
    286     ),
    287     (
    288         "taler-merchant-manual",
    289         "taler-merchant-manual.tex",
    290         "GNU Taler Merchant Manual",
    291         "GNU Taler team",
    292         "manual",
    293     ),
    294     (
    295         "taler-merchant-pos-terminal",
    296         "taler-merchant-pos-terminal.tex",
    297         "GNU Taler Merchant POS Terminal",
    298         "GNU Taler team",
    299         "manual",
    300     ),
    301     # (
    302     #     "taler-merchant-api-tutorial",
    303     #     "taler-merchant-api-tutorial.tex",
    304     #     "GNU Taler Merchant API Tutorial",
    305     #     "GNU Taler team",
    306     #     "manual",
    307     # ),
    308     (
    309         "taler-developer-manual",
    310         "taler-developer-manual.tex",
    311         "GNU Taler Developer Manual",
    312         "GNU Taler team",
    313         "manual",
    314     ),
    315 ]
    316 
    317 # The name of an image file (relative to this directory) to place at the top of
    318 # the title page.
    319 # latex_logo = None
    320 
    321 # For "manual" documents, if this is true, then toplevel headings are parts,
    322 # not chapters.
    323 # latex_use_parts = False
    324 
    325 # If true, show page references after internal links.
    326 # latex_show_pagerefs = False
    327 
    328 # If true, show URL addresses after external links.
    329 # latex_show_urls = False
    330 
    331 # Documents to append as an appendix to all manuals.
    332 latex_appendices = ["fdl-1.3"]
    333 
    334 # If false, no module index is generated.
    335 # latex_domain_indices = True
    336 
    337 # -- Options for manual page output ---------------------------------------
    338 
    339 # One entry per manual page. List of tuples
    340 # (source start file, name, description, authors, manual section).
    341 man_pages = [
    342     (
    343         "manpages/challenger-config.1",
    344         "challenger-config",
    345         "manipulate Challenger configuration files",
    346         "GNU Taler contributors",
    347         1,
    348     ),
    349     (
    350         "manpages/challenger-dbinit.1",
    351         "challenger-dbinit",
    352         "initialize the Challenger database",
    353         "GNU Taler contributors",
    354         1,
    355     ),
    356     (
    357         "manpages/challenger-admin.1",
    358         "challenger-admin",
    359         "manipulate list of authorized Challenger clients",
    360         "GNU Taler contributors",
    361         1,
    362     ),
    363     (
    364         "manpages/challenger-httpd.1",
    365         "challenger-httpd",
    366         "provide the Challenger HTTP interface",
    367         "GNU Taler contributors",
    368         1,
    369     ),
    370     (
    371         "manpages/challenger.conf.5",
    372         "challenger.conf",
    373         "Challenger configuration file",
    374         "GNU Taler contributors",
    375         5,
    376     ),
    377     (
    378         "manpages/paivana.conf.5",
    379         "paivana.conf",
    380         "Configuration for Paivana",
    381         "GNU Taler contributors",
    382         5,
    383     ),
    384     (
    385         "manpages/sync-config.1",
    386         "sync-config",
    387         "manipulate Sync configuration files",
    388         "GNU Taler contributors",
    389         1,
    390     ),
    391     (
    392         "manpages/sync-dbinit.1",
    393         "sync-dbinit",
    394         "initialize the Sync database",
    395         "GNU Taler contributors",
    396         1,
    397     ),
    398     (
    399         "manpages/sync-httpd.1",
    400         "sync-httpd",
    401         "provide the Sync HTTP interface",
    402         "GNU Taler contributors",
    403         1,
    404     ),
    405     (
    406         "manpages/paivana-httpd.1",
    407         "paivana-httpd",
    408         "reverse-proxy paywall using GNU Taler",
    409         "GNU Taler contributors",
    410         1,
    411     ),
    412     (
    413         "manpages/sync.conf.5",
    414         "sync.conf",
    415         "Sync configuration file",
    416         "GNU Taler contributors",
    417         5,
    418     ),
    419     (
    420         "manpages/taler-directory-config.1",
    421         "taler-directory-config",
    422         "manipulate Taler Directory configuration files",
    423         "GNU Taler contributors",
    424         1,
    425     ),
    426     (
    427         "manpages/taler-directory-dbinit.1",
    428         "taler-directory-dbinit",
    429         "initialize the Taler directory database",
    430         "GNU Taler contributors",
    431         1,
    432     ),
    433     (
    434         "manpages/taler-directory-httpd.1",
    435         "taler-directory-httpd",
    436         "provide the Taler directory HTTP interface",
    437         "GNU Taler contributors",
    438         1,
    439     ),
    440     (
    441         "manpages/taler-directory-cli.1",
    442         "taler-directory-cli",
    443         "provide the Taler directory CLI helper interface",
    444         "GNU Taler contributors",
    445         1,
    446     ),
    447     (
    448         "manpages/taler-directory.conf.5",
    449         "taler-directory.conf",
    450         "Taler directory configuration file",
    451         "GNU Taler contributors",
    452         5,
    453     ),
    454     (
    455         "manpages/taler-mailbox-config.1",
    456         "taler-mailbox-config",
    457         "manipulate Taler mailbox configuration files",
    458         "GNU Taler contributors",
    459         1,
    460     ),
    461     (
    462         "manpages/taler-mailbox-dbinit.1",
    463         "taler-mailbox-dbinit",
    464         "initialize the Taler mailbox database",
    465         "GNU Taler contributors",
    466         1,
    467     ),
    468     (
    469         "manpages/taler-mailbox-httpd.1",
    470         "taler-mailbox-httpd",
    471         "provide the Taler mailbox HTTP interface",
    472         "GNU Taler contributors",
    473         1,
    474     ),
    475     (
    476         "manpages/taler-mailbox.conf.5",
    477         "taler-mailbox.conf",
    478         "Taler mailbox configuration file",
    479         "GNU Taler contributors",
    480         5,
    481     ),
    482     (
    483         "manpages/donau-config.1",
    484         "donau-config",
    485         "manipulate Donau configuration files",
    486         "GNU Taler contributors",
    487         1,
    488     ),
    489     (
    490         "manpages/donau-dbconfig.1",
    491         "donau-dbconfig",
    492         "configure Donau database",
    493         "GNU Taler contributors",
    494         1,
    495     ),
    496     (
    497         "manpages/donau-dbinit.1",
    498         "donau-dbinit",
    499         "initialize the Donau database",
    500         "GNU Taler contributors",
    501         1,
    502     ),
    503     (
    504         "manpages/donau-httpd.1",
    505         "donau-httpd",
    506         "provide the Donau HTTP interface",
    507         "GNU Taler contributors",
    508         1,
    509     ),
    510     (
    511         "manpages/donau.conf.5",
    512         "donau.conf",
    513         "Donau configuration file",
    514         "GNU Taler contributors",
    515         5,
    516     ),
    517     (
    518         "manpages/donau-secmod-eddsa.1",
    519         "donau-secmod-eddsa",
    520         "handle private EDDSA key operations for a Donau",
    521         "GNU Taler contributors",
    522         1,
    523     ),
    524     (
    525         "manpages/donau-secmod-cs.1",
    526         "donau-secmod-cs",
    527         "handle private CS key operations for a Donau",
    528         "GNU Taler contributors",
    529         1,
    530     ),
    531     (
    532         "manpages/donau-secmod-rsa.1",
    533         "donau-secmod-rsa",
    534         "handle private RSA key operations for a Donau",
    535         "GNU Taler contributors",
    536         1,
    537     ),
    538 
    539     (
    540         "manpages/taler-auditor-dbinit.1",
    541         "taler-auditor-dbinit",
    542         "setup auditor database",
    543         "GNU Taler contributors",
    544         1,
    545     ),
    546     (
    547         "manpages/taler-auditor-sync.1",
    548         "taler-auditor-sync",
    549         "tool to safely synchronize auditor database",
    550         "GNU Taler contributors",
    551         1,
    552     ),
    553     (
    554         "manpages/taler-auditor-httpd.1",
    555         "taler-auditor-httpd",
    556         "HTTP server providing a RESTful API to access a Taler auditor",
    557         "GNU Taler contributors",
    558         1,
    559     ),
    560     (
    561         "manpages/taler-exchange-aggregator.1",
    562         "taler-exchange-aggregator",
    563         "aggregate deposits into wire transfers",
    564         "GNU Taler contributors",
    565         1,
    566     ),
    567     (
    568         "manpages/taler-terms-generator.1",
    569         "taler-terms-generator",
    570         "create legal policy documents for services",
    571         "GNU Taler contributors",
    572         1,
    573     ),
    574     (
    575         "manpages/taler-fakebank-run.1",
    576         "taler-fakebank-run",
    577         "run in-memory bank service for testing and benchmarking",
    578         "GNU Taler contributors",
    579         1,
    580     ),
    581     (
    582         "manpages/taler-exchange-closer.1",
    583         "taler-exchange-closer",
    584         "close idle reserves",
    585         "GNU Taler contributors",
    586         1,
    587     ),
    588     (
    589         "manpages/taler-exchange-drain.1",
    590         "taler-exchange-drain",
    591         "drain profits from exchange",
    592         "GNU Taler contributors",
    593         1,
    594     ),
    595     (
    596         "manpages/taler-exchange-kyc-tester.1",
    597         "taler-exchange-kyc-tester",
    598         "test KYC service integration",
    599         "GNU Taler contributors",
    600         1,
    601     ),
    602     (
    603         "manpages/taler-exchange-expire.1",
    604         "taler-exchange-expire",
    605         "refund expired purses",
    606         "GNU Taler contributors",
    607         1,
    608     ),
    609     (
    610         "manpages/taler-exchange-router.1",
    611         "taler-exchange-router",
    612         "route payments to partner exchanges",
    613         "GNU Taler contributors",
    614         1,
    615     ),
    616     (
    617         "manpages/taler-exchange-transfer.1",
    618         "taler-exchange-transfer",
    619         "execute wire transfers",
    620         "GNU Taler contributors",
    621         1,
    622     ),
    623     (
    624         "manpages/taler-unified-setup.1",
    625         "taler-unified-setup",
    626         "conveniently start and stop various GNU Taler services",
    627         "GNU Taler contributors",
    628         1,
    629     ),
    630     (
    631         "manpages/taler-exchange-benchmark.1",
    632         "taler-exchange-benchmark",
    633         "measure exchange performance",
    634         "GNU Taler contributors",
    635         1,
    636     ),
    637     (
    638         "manpages/taler-bank-benchmark.1",
    639         "taler-bank-benchmark",
    640         "measure bank performance",
    641         "GNU Taler contributors",
    642         1,
    643     ),
    644     (
    645         "manpages/taler-aggregator-benchmark.1",
    646         "taler-aggregator-benchmark",
    647         "generate database to measure aggregator performance",
    648         "GNU Taler contributors",
    649         1,
    650     ),
    651     (
    652         "manpages/taler-auditor-dbconfig.1",
    653         "taler-auditor-dbconfig",
    654         "configure Taler auditor database",
    655         "GNU Taler contributors",
    656         1,
    657     ),
    658     (
    659         "manpages/taler-exchange-dbconfig.1",
    660         "taler-exchange-dbconfig",
    661         "configure Taler exchange database",
    662         "GNU Taler contributors",
    663         1,
    664     ),
    665     (
    666         "manpages/taler-merchant-dbconfig.1",
    667         "taler-merchant-dbconfig",
    668         "configure Taler merchant database",
    669         "GNU Taler contributors",
    670         1,
    671     ),
    672     (
    673         "manpages/sync-dbconfig.1",
    674         "sync-dbconfig",
    675         "configure sync database",
    676         "GNU Taler contributors",
    677         1,
    678     ),
    679     (
    680         "manpages/challenger-dbconfig.1",
    681         "challenger-dbconfig",
    682         "configure challenger database",
    683         "GNU Taler contributors",
    684         1,
    685     ),
    686     (
    687         "manpages/taler-exchange-dbinit.1",
    688         "taler-exchange-dbinit",
    689         "initialize Taler exchange database",
    690         "GNU Taler contributors",
    691         1,
    692     ),
    693     (
    694         "manpages/taler-exchange-httpd.1",
    695         "taler-exchange-httpd",
    696         "run Taler exchange (with RESTful API)",
    697         "GNU Taler contributors",
    698         1,
    699     ),
    700     (
    701         "manpages/taler-auditor-offline.1",
    702         "taler-auditor-offline",
    703         "Taler auditor certifies that it audits a Taler exchange",
    704         "GNU Taler contributors",
    705         1,
    706     ),
    707     (
    708         "manpages/taler-exchange-offline.1",
    709         "taler-exchange-offline",
    710         "operations using the offline key of a Taler exchange",
    711         "GNU Taler contributors",
    712         1,
    713     ),
    714     (
    715         "manpages/taler-exchange-kyc-trigger.1",
    716         "taler-exchange-kyc-trigger",
    717         "trigger AML/KYC measures by simulating wallet balances thresholds being crossed for testing AML/KYC procedures",
    718         "GNU Taler contributors",
    719         1,
    720     ),
    721     (
    722         "manpages/taler-exchange-sanctionscheck.1",
    723         "taler-exchange-sanctionscheck",
    724         "check KYC attributes of all accounts against a sanctions list",
    725         "GNU Taler contributors",
    726         1,
    727     ),
    728     (
    729         "manpages/robocop.1",
    730         "robocop",
    731         "compare KYC records against a sanctions list and find best match",
    732         "GNU Taler contributors",
    733         1,
    734     ),
    735     (
    736         "manpages/taler-exchange-wirewatch.1",
    737         "taler-exchange-wirewatch",
    738         "watch for incoming wire transfers",
    739         "GNU Taler contributors",
    740         1,
    741     ),
    742     (
    743         "manpages/taler-merchant-reconciliation.1",
    744         "taler-merchant-reconciliation",
    745         "ask exchange which deposits were aggregated for a particular wire transfer that credited a merchant account",
    746         "GNU Taler contributors",
    747         1,
    748     ),
    749     (
    750         "manpages/taler-merchant-report-generator.1",
    751         "taler-merchant-report-generator",
    752         "background job that periodically fetches and submits reports",
    753         "GNU Taler contributors",
    754         1,
    755     ),
    756     (
    757         "manpages/taler-merchant-report-generator-email.1",
    758         "taler-merchant-report-generator-email",
    759         "helper for taler-merchant-report-generator that handles submission via e-mail",
    760         "GNU Taler contributors",
    761         1,
    762     ),
    763     (
    764         "manpages/taler-merchant-kyccheck.1",
    765         "taler-merchant-kyccheck",
    766         "ask exchange about KYC status of merchant bank accounts",
    767         "GNU Taler contributors",
    768         1,
    769     ),
    770     (
    771         "manpages/taler-merchant-exchangekeyupdate.1",
    772         "taler-merchant-exchangekeyupdate",
    773         "keep exchange key material up-to-date",
    774         "GNU Taler contributors",
    775         1,
    776     ),
    777     (
    778         "manpages/taler-merchant-donaukeyupdate.1",
    779         "taler-merchant-donaukeyupdate",
    780         "keep Donau key material up-to-date",
    781         "GNU Taler contributors",
    782         1,
    783     ),
    784     (
    785         "manpages/taler-merchant-benchmark.1",
    786         "taler-merchant-benchmark",
    787         "generate Taler-style benchmarking payments",
    788         "GNU Taler contributors",
    789         1,
    790     ),
    791     (
    792         "manpages/taler-mdb.1",
    793         "taler-mdb",
    794         "operate multi drop bus (MDB) based vending machines with Taler payments",
    795         "GNU Taler contributors",
    796         1,
    797     ),
    798     (
    799         "manpages/taler-mdb-display.1",
    800         "taler-mdb-display",
    801         "turns the framebuffer backlight on or off",
    802         "GNU Taler contributors",
    803         1,
    804     ),
    805     (
    806         "manpages/taler-mdb-qr-show.1",
    807         "taler-mdb-qr-show",
    808         "show text encoded as QR code on the framebuffer",
    809         "GNU Taler contributors",
    810         1,
    811     ),
    812     (
    813         "manpages/taler-mdb-show.sh.1",
    814         "taler-mdb-show.sh",
    815         "render informational status images on vending machines' displays",
    816         "GNU Taler contributors",
    817         1,
    818     ),
    819     (
    820         "manpages/taler-mdb-ads.sh.1",
    821         "taler-mdb-ads.sh",
    822         "renders advertisements on vending machines' displays while taler-mdb is idle",
    823         "GNU Taler contributors",
    824         1,
    825     ),
    826     (
    827         "manpages/taler-mdb-network-check.sh.1",
    828         "taler-mdb-network-check.sh",
    829         "handle network checks on vending machines",
    830         "GNU Taler contributors",
    831         1,
    832     ),
    833     (
    834         "manpages/taler-merchant-dbinit.1",
    835         "taler-merchant-dbinit",
    836         "initialize Taler merchant database",
    837         "GNU Taler contributors",
    838         1,
    839     ),
    840     (
    841         "manpages/taler-merchant-passwd.1",
    842         "taler-merchant-passwd",
    843         "change Taler merchant instance password",
    844         "GNU Taler contributors",
    845         1,
    846     ),
    847     (
    848         "manpages/taler-merchant-httpd.1",
    849         "taler-merchant-httpd",
    850         "run Taler merchant backend (with RESTful API)",
    851         "GNU Taler contributors",
    852         1,
    853     ),
    854     (
    855         "manpages/taler-merchant-rproxy-setup.1",
    856         "taler-merchant-rproxy-setup",
    857         "automatically setup reverse proxy for a Taler merchant backend",
    858         "GNU Taler contributors",
    859         1,
    860     ),
    861     (
    862         "manpages/taler-merchant-webhook.1",
    863         "taler-merchant-webhook",
    864         "execute webhooks of the Taler merchant backend (optional service)",
    865         "GNU Taler contributors",
    866         1,
    867     ),
    868     (
    869         "manpages/taler-merchant-wirewatch.1",
    870         "taler-merchant-wirewatch",
    871         "import credit transactions from a merchant bank account into merchant backend (optional)",
    872         "GNU Taler contributors",
    873         1,
    874     ),
    875     (
    876         "manpages/taler-merchant-depositcheck.1",
    877         "taler-merchant-depositcheck",
    878         "check status of deposits with exchange",
    879         "GNU Taler contributors",
    880         1,
    881     ),
    882     (
    883         "manpages/taler-exchange-wire-gateway-client.1",
    884         "taler-exchange-wire-gateway-client",
    885         "trigger a transfer at the bank",
    886         "GNU Taler contributors",
    887         1,
    888     ),
    889     (
    890         "manpages/taler-auditor-config.1",
    891         "taler-auditor-config",
    892         "Taler auditor configuration inspection and editing",
    893         "GNU Taler contributors",
    894         1,
    895     ),
    896     (
    897         "manpages/taler-exchange-config.1",
    898         "taler-exchange-config",
    899         "Taler exchange configuration inspection and editing",
    900         "GNU Taler contributors",
    901         1,
    902     ),
    903     (
    904         "manpages/taler-merchant-config.1",
    905         "taler-merchant-config",
    906         "Taler merchant configuration inspection and editing",
    907         "GNU Taler contributors",
    908         1,
    909     ),
    910     (
    911         "manpages/taler-exchange-kyc-aml-pep-trigger.1",
    912         "taler-exchange-kyc-aml-pep-trigger",
    913         "Taler KYC_AML_TRIGGER example",
    914         "GNU Taler contributors",
    915         1,
    916     ),
    917     (
    918         "manpages/taler-auditor.conf.5",
    919         "taler-auditor.conf",
    920         "Taler auditor configuration file",
    921         "GNU Taler contributors",
    922         5,
    923     ),
    924     (
    925         "manpages/taler-exchange.conf.5",
    926         "taler-exchange.conf",
    927         "Taler exchange configuration file",
    928         "GNU Taler contributors",
    929         5,
    930     ),
    931     (
    932         "manpages/taler-fakebank.conf.5",
    933         "taler-fakebank.conf",
    934         "Taler fakebank configuration file",
    935         "GNU Taler contributors",
    936         5,
    937     ),
    938     (
    939         "manpages/taler-mdb.conf.5",
    940         "taler-mdb.conf",
    941         "Taler-mdb configuration file",
    942         "GNU Taler contributors",
    943         5,
    944     ),
    945     (
    946         "manpages/taler-merchant.conf.5",
    947         "taler-merchant.conf",
    948         "Taler merchant configuration file",
    949         "GNU Taler contributors",
    950         5,
    951     ),
    952     (
    953         "manpages/taler-exchange-secmod-eddsa.1",
    954         "taler-exchange-secmod-eddsa",
    955         "handle private EDDSA key operations for a Taler exchange",
    956         "GNU Taler contributors",
    957         1,
    958     ),
    959     (
    960         "manpages/taler-exchange-secmod-cs.1",
    961         "taler-exchange-secmod-cs",
    962         "handle private CS key operations for a Taler exchange",
    963         "GNU Taler contributors",
    964         1,
    965     ),
    966     (
    967         "manpages/taler-exchange-secmod-rsa.1",
    968         "taler-exchange-secmod-rsa",
    969         "handle private RSA key operations for a Taler exchange",
    970         "GNU Taler contributors",
    971         1,
    972     ),
    973     (
    974         "manpages/taler-helper-auditor-aggregation.1",
    975         "taler-helper-auditor-aggregation",
    976         "audit Taler exchange aggregation activity",
    977         "GNU Taler contributors",
    978         1,
    979     ),
    980     (
    981         "manpages/taler-helper-auditor-coins.1",
    982         "taler-helper-auditor-coins",
    983         "audit Taler coin processing",
    984         "GNU Taler contributors",
    985         1,
    986     ),
    987     (
    988         "manpages/taler-helper-auditor-deposits.1",
    989         "taler-helper-auditor-deposits",
    990         "audit Taler exchange database for deposit confirmation consistency",
    991         "GNU Taler contributors",
    992         1,
    993     ),
    994     (
    995         "manpages/taler-helper-auditor-purses.1",
    996         "taler-helper-auditor-purses",
    997         "audit Taler exchange purse handling",
    998         "GNU Taler contributors",
    999         1,
   1000     ),
   1001     (
   1002         "manpages/taler-helper-auditor-reserves.1",
   1003         "taler-helper-auditor-reserves",
   1004         "audit Taler exchange reserve handling",
   1005         "GNU Taler contributors",
   1006         1,
   1007     ),
   1008     (
   1009         "manpages/taler-helper-auditor-wire-credit.1",
   1010         "taler-helper-auditor-wire-credit",
   1011         "audit exchange database for consistency with the bank's wire transfers",
   1012         "GNU Taler contributors",
   1013         1,
   1014     ),
   1015     (
   1016         "manpages/taler-helper-auditor-wire-debit.1",
   1017         "taler-helper-auditor-wire-debit",
   1018         "audit exchange database for consistency with the bank's wire transfers",
   1019         "GNU Taler contributors",
   1020         1,
   1021     ),
   1022     (
   1023         "manpages/libeufin-nexus.1",
   1024         "libeufin-nexus",
   1025         "service to interface to various bank access APIs",
   1026         "GNU Taler contributors",
   1027         1,
   1028     ),
   1029     (
   1030         "manpages/libeufin-nexus.conf.5",
   1031         "libeufin-nexus.conf",
   1032         "LibEuFin Nexus configuration file",
   1033         "GNU Taler contributors",
   1034         5,
   1035     ),
   1036     (
   1037         "manpages/libeufin-bank.1",
   1038         "libeufin-bank",
   1039         "implementation of a regional currency bank",
   1040         "GNU Taler contributors",
   1041         1,
   1042     ),
   1043     (
   1044         "manpages/libeufin-bank.conf.5",
   1045         "libeufin-bank.conf",
   1046         "LibEuFin Bank configuration file",
   1047         "GNU Taler contributors",
   1048         5,
   1049     ),
   1050     (
   1051         "manpages/libeufin-ebisync.1",
   1052         "libeufin-ebisync",
   1053         "service to synchronize files via EBICS",
   1054         "GNU Taler contributors",
   1055         1,
   1056     ),
   1057     (
   1058         "manpages/libeufin-ebisync.conf.5",
   1059         "libeufin-ebisync.conf",
   1060         "LibEuFin EbiSync configuration file",
   1061         "GNU Taler contributors",
   1062         5,
   1063     ),
   1064     (
   1065         "manpages/depolymerizer-bitcoin.1",
   1066         "depolymerizer-bitcoin",
   1067         "implementation of a bitcoin depolymerizer",
   1068         "GNU Taler contributors",
   1069         1,
   1070     ),
   1071     (
   1072         "manpages/depolymerizer-bitcoin.conf.5",
   1073         "depolymerizer-bitcoin.conf",
   1074         "Bitcoin depolymerizer configuration file",
   1075         "GNU Taler contributors",
   1076         5,
   1077     ),
   1078     (
   1079         "manpages/taler-magnet-bank.1",
   1080         "taler-magnet-bank",
   1081         "implementation of Magnet Bank Taler adapter",
   1082         "GNU Taler contributors",
   1083         1,
   1084     ),
   1085     (
   1086         "manpages/taler-magnet-bank.conf.5",
   1087         "taler-magnet-bank.conf",
   1088         "Magnet Bank adapter configuration file",
   1089         "GNU Taler contributors",
   1090         5,
   1091     ),
   1092     (
   1093         "manpages/taler-cyclos.1",
   1094         "taler-cyclos",
   1095         "implementation of Cyclos Taler adapter",
   1096         "GNU Taler contributors",
   1097         1,
   1098     ),
   1099     (
   1100         "manpages/taler-cyclos.conf.5",
   1101         "taler-cyclos.conf",
   1102         "Cyclos adapter configuration file",
   1103         "GNU Taler contributors",
   1104         5,
   1105     ),
   1106     (
   1107         "manpages/taler-wise.1",
   1108         "taler-wise",
   1109         "implementation of Wise Taler adapter",
   1110         "GNU Taler contributors",
   1111         1,
   1112     ),
   1113     (
   1114         "manpages/taler-wise.conf.5",
   1115         "taler-wise.conf",
   1116         "Wise adapter configuration file",
   1117         "GNU Taler contributors",
   1118         5,
   1119     ),
   1120     (
   1121         "manpages/taler-apns-relay.1",
   1122         "taler-apns-relay",
   1123         "implementation of Taler APNs relay",
   1124         "GNU Taler contributors",
   1125         1,
   1126     ),
   1127     (
   1128         "manpages/taler-apns-relay.conf.5",
   1129         "taler-apns-relay.conf",
   1130         "APNs relay configuration file",
   1131         "GNU Taler contributors",
   1132         5,
   1133     ),
   1134 ]
   1135 
   1136 # If true, show URL addresses after external links.
   1137 # man_show_urls = False
   1138 
   1139 # -- Options for Texinfo output -------------------------------------------
   1140 
   1141 # Grouping the document tree into Texinfo files. List of tuples
   1142 # (source start file, target name, title, author,
   1143 #  dir menu entry, description, category)
   1144 texinfo_documents = [
   1145     (
   1146         "taler-auditor-manual",
   1147         "taler-auditor",
   1148         "Taler Auditor Manual",
   1149         "GNU Taler team",
   1150         "GNU Taler Auditor",
   1151         "External audit for Taler Exchange operation",
   1152         "Network applications",
   1153     ),
   1154     (
   1155         "taler-exchange-manual",
   1156         "taler-exchange",
   1157         "Taler Exchange Manual",
   1158         "GNU Taler team",
   1159         "GNU Taler Exchange",
   1160         "Taler payment service provider",
   1161         "Network applications",
   1162     ),
   1163     (
   1164         "taler-challenger-manual",
   1165         "challenger",
   1166         "Taler Challenger Manual",
   1167         "GNU Taler team",
   1168         "GNU Taler Challenger",
   1169         "Customer address validation service",
   1170         "Network applications",
   1171     ),
   1172     (
   1173         "taler-merchant-manual",
   1174         "taler-merchant",
   1175         "Taler Merchant Manual",
   1176         "GNU Taler team",
   1177         "GNU Taler Merchant",
   1178         "Backend for merchants accepting Taler payments",
   1179         "Network applications",
   1180     ),
   1181     # (
   1182     #     "taler-merchant-api-tutorial",
   1183     #     "taler-merchant-api-tutorial",
   1184     #     "Taler Merchant API Tutorial",
   1185     #     "GNU Taler team",
   1186     #     "GNU Taler Merchant API",
   1187     #     "Tutorial for using the merchant backend API",
   1188     #     "Network applications",
   1189     # ),
   1190     (
   1191         "taler-developer-manual",
   1192         "taler-developer-manual",
   1193         "Taler Developer Manual",
   1194         "GNU Taler team",
   1195         "GNU Taler Development",
   1196         "Manual for GNU Taler contributors",
   1197         "Network applications",
   1198     ),
   1199 ]
   1200 
   1201 # Documents to append as an appendix to all manuals.
   1202 # texinfo_appendices = []
   1203 
   1204 # If false, no module index is generated.
   1205 # texinfo_domain_indices = True
   1206 
   1207 # How to display URL addresses: 'footnote', 'no', or 'inline'.
   1208 # texinfo_show_urls = 'footnote'
   1209 
   1210 # If true, do not generate a @detailmenu in the "Top" node's menu.
   1211 # texinfo_no_detailmenu = False
   1212 
   1213 # The output format for Graphviz when building HTML files.
   1214 # This must be either 'png' or 'svg'; the default is 'png'.
   1215 graphviz_output_format = "svg"
   1216 
   1217 myst_heading_anchors = 3
   1218 
   1219 myst_enable_extensions = [
   1220 ]
   1221 
   1222 
   1223 rst_prolog = """
   1224 .. |democheck| raw:: html
   1225 
   1226     <input type="checkbox">
   1227 """