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