conf.py - taler-docs - Documentation for GNU Taler components, APIs and protocols

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