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