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