diff options
Diffstat (limited to 'conf.py')
| -rw-r--r-- | conf.py | 254 |
1 files changed, 213 insertions, 41 deletions
@@ -1,6 +1,6 @@ """ This file is part of GNU TALER. - Copyright (C) 2014, 2015, 2016, 2020, 2021 Taler Systems SA + Copyright (C) 2014-2023 Taler Systems SA TALER is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software @@ -17,6 +17,7 @@ @author Benedikt Muller @author Sree Harsha Totakura @author Marcello Stanisci + @author Christian Grothoff """ # -*- coding: utf-8 -*- # @@ -37,8 +38,6 @@ import os sys.path.append(os.path.abspath("_exts")) -import taler_sphinx_theme - # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -55,7 +54,6 @@ needs_sphinx = "2.2.0" extensions = [ "ebicsdomain", "typescriptdomain", - "taler_sphinx_theme", "sphinx.ext.todo", "sphinx.ext.imgmath", "httpdomain.httpdomain", @@ -80,16 +78,16 @@ master_doc = "index" # General information about the project. project = "GNU Taler" -copyright = "2014-2022 Taler Systems SA (GPLv3+ or GFDL 1.3+)" +copyright = "2014-2024 Taler Systems SA (GPLv3+ or GFDL 1.3+)" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = "0.9" +version = "0.10" # The full version, including alpha/beta/rc tags. -release = "0.9.0" +release = "0.10.0" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -110,6 +108,8 @@ exclude_patterns = [ "prebuilt", "**/README.md", "extract-tsdefs", + "frags", + "orphaned", ] # The reST default role (used for this markup: `text`) to use for all @@ -140,16 +140,15 @@ pygments_style = "sphinx" # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = "taler_sphinx_theme" -html_theme_path = taler_sphinx_theme.html_theme_path() +html_theme = "sphinx_book_theme" -html_sidebars = {"**": ["logo-text.html", "globaltoc.html", "searchbox.html"]} +#html_sidebars = {"**": ["logo-text.html", "globaltoc.html", "searchbox.html"]} +#html_sidebars = {"**": ["globaltoc.html", "searchbox.html"]} html_theme_options = { # Set the name of the project to appear in the sidebar - "project_nav_name": "GNU Taler", - "globaltoc_depth": 4, - "globaltoc_includehidden": False, + "home_page_in_toc": True, + "show_navbar_depth": 1, } # Add any paths that contain custom themes here, relative to this directory. @@ -157,14 +156,14 @@ html_theme_options = { # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". -# html_title = None +html_title = "GNU Taler" # A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None +html_short_title = "GNU Taler" # The name of an image file (relative to this directory) to place at the top # of the sidebar. -# html_logo = None +html_logo = "images/taler-logo.svg" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 @@ -176,6 +175,9 @@ html_theme_options = { # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] +# This is a sphinx-book-themes specific parameter to allow for customized css +html_css_files = ["custom.css"] + # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. @@ -252,6 +254,13 @@ latex_documents = [ "manual", ), ( + "taler-challenger-manual", + "taler-challenger-manual.tex", + "GNU Taler Challenger Manual", + "GNU Taler team", + "manual", + ), + ( "taler-merchant-manual", "taler-merchant-manual.tex", "GNU Taler Merchant Manual", @@ -307,6 +316,41 @@ latex_appendices = ["fdl-1.3"] # (source start file, name, description, authors, manual section). man_pages = [ ( + "manpages/challenger-config.1", + "challenger-config", + "manipulate Challenger configuration files", + "GNU Taler contributors", + 1, + ), + ( + "manpages/challenger-dbinit.1", + "challenger-dbinit", + "initialize the Challenger database", + "GNU Taler contributors", + 1, + ), + ( + "manpages/challenger-admin.1", + "challenger-admin", + "manipulate list of authorized Challenger clients", + "GNU Taler contributors", + 1, + ), + ( + "manpages/challenger-httpd.1", + "challenger-httpd", + "provide the Challenger HTTP interface", + "GNU Taler contributors", + 1, + ), + ( + "manpages/challenger.conf.5", + "challenger.conf", + "Challenger configuration file", + "GNU Taler contributors", + 5, + ), + ( "manpages/sync-config.1", "sync-config", "manipulate Sync configuration files", @@ -377,6 +421,20 @@ man_pages = [ 1, ), ( + "manpages/taler-terms-generator.1", + "taler-terms-generator", + "create legal policy documents for services", + "GNU Taler contributors", + 1, + ), + ( + "manpages/taler-fakebank-run.1", + "taler-fakebank-run", + "run in-memory bank service for testing and benchmarking", + "GNU Taler contributors", + 1, + ), + ( "manpages/taler-exchange-closer.1", "taler-exchange-closer", "close idle reserves", @@ -419,6 +477,13 @@ man_pages = [ 1, ), ( + "manpages/taler-unified-setup.1", + "taler-unified-setup", + "conveniently start and stop various GNU Taler services", + "GNU Taler contributors", + 1, + ), + ( "manpages/taler-exchange-benchmark.1", "taler-exchange-benchmark", "measure exchange performance", @@ -426,6 +491,55 @@ man_pages = [ 1, ), ( + "manpages/taler-bank-benchmark.1", + "taler-bank-benchmark", + "measure bank performance", + "GNU Taler contributors", + 1, + ), + ( + "manpages/taler-aggregator-benchmark.1", + "taler-aggregator-benchmark", + "generate database to measure aggregator performance", + "GNU Taler contributors", + 1, + ), + ( + "manpages/taler-auditor-dbconfig.1", + "taler-auditor-dbconfig", + "configure Taler auditor database", + "GNU Taler contributors", + 1, + ), + ( + "manpages/taler-exchange-dbconfig.1", + "taler-exchange-dbconfig", + "configure Taler exchange database", + "GNU Taler contributors", + 1, + ), + ( + "manpages/taler-merchant-dbconfig.1", + "taler-merchant-dbconfig", + "configure Taler merchant database", + "GNU Taler contributors", + 1, + ), + ( + "manpages/sync-dbconfig.1", + "sync-dbconfig", + "configure sync database", + "GNU Taler contributors", + 1, + ), + ( + "manpages/challenger-dbconfig.1", + "challenger-dbconfig", + "configure challenger database", + "GNU Taler contributors", + 1, + ), + ( "manpages/taler-exchange-dbinit.1", "taler-exchange-dbinit", "initialize Taler exchange database", @@ -461,6 +575,13 @@ man_pages = [ 1, ), ( + "manpages/taler-merchant-exchange.1", + "taler-merchant-exchange", + "ask exchange which deposits were aggregated for a particular wire transfer that credited a merchant account", + "GNU Taler contributors", + 1, + ), + ( "manpages/taler-merchant-benchmark.1", "taler-merchant-benchmark", "generate Taler-style benchmarking payments", @@ -468,6 +589,13 @@ man_pages = [ 1, ), ( + "manpages/taler-mdb.1", + "taler-mdb", + "operate multi drop bus (MDB) based vending machines with Taler payments", + "GNU Taler contributors", + 1, + ), + ( "manpages/taler-merchant-dbinit.1", "taler-merchant-dbinit", "initialize Taler merchant database", @@ -475,6 +603,13 @@ man_pages = [ 1, ), ( + "manpages/taler-merchant-passwd.1", + "taler-merchant-passwd", + "change Taler merchant instance password", + "GNU Taler contributors", + 1, + ), + ( "manpages/taler-merchant-httpd.1", "taler-merchant-httpd", "run Taler merchant backend (with RESTful API)", @@ -482,9 +617,23 @@ man_pages = [ 1, ), ( - "manpages/taler-merchant-setup-reserve.1", - "taler-merchant-setup-reserve", - "setup reserve for tipping at a Taler merchant backend", + "manpages/taler-merchant-webhook.1", + "taler-merchant-webhook", + "execute webhooks of the Taler merchant backend (optional service)", + "GNU Taler contributors", + 1, + ), + ( + "manpages/taler-merchant-wirewatch.1", + "taler-merchant-wirewatch", + "import credit transactions from a merchant bank account into merchant backend (optional)", + "GNU Taler contributors", + 1, + ), + ( + "manpages/taler-merchant-depositcheck.1", + "taler-merchant-depositcheck", + "check status of deposits with exchange", "GNU Taler contributors", 1, ), @@ -503,6 +652,13 @@ man_pages = [ 1, ), ( + "manpages/taler-exchange-kyc-aml-pep-trigger.1", + "taler-exchange-kyc-aml-pep-trigger", + "Taler KYC_AML_TRIGGER example", + "GNU Taler contributors", + 1, + ), + ( "manpages/taler.conf.5", "taler.conf", "Taler configuration file", @@ -552,6 +708,13 @@ man_pages = [ 1, ), ( + "manpages/taler-helper-auditor-purses.1", + "taler-helper-auditor-purses", + "audit Taler exchange purse handling", + "GNU Taler contributors", + 1, + ), + ( "manpages/taler-helper-auditor-reserves.1", "taler-helper-auditor-reserves", "audit Taler exchange reserve handling", @@ -566,19 +729,19 @@ man_pages = [ 1, ), ( - "manpages/libeufin-sandbox.1", - "libeufin-sandbox", - "simulate core banking system with EBICS access to bank accounts", - "GNU Taler contributors", - 1, - ), - ( "manpages/libeufin-nexus.1", "libeufin-nexus", "service to interface to various bank access APIs", "GNU Taler contributors", 1, ), + ( + "manpages/libeufin-nexus.conf.5", + "libeufin-nexus.conf", + "LibEuFin Nexus configuration file", + "GNU Taler contributors", + 5, + ), ] # If true, show URL addresses after external links. @@ -595,45 +758,54 @@ texinfo_documents = [ "taler-auditor", "Taler Auditor Manual", "GNU Taler team", - "MENU ENTRY", - "DESCRIPTION", - "CATEGORY", + "GNU Taler Auditor", + "External audit for Taler Exchange operation", + "Network applications", ), ( "taler-exchange-manual", "taler-exchange", "Taler Exchange Manual", "GNU Taler team", - "MENU ENTRY", - "DESCRIPTION", - "CATEGORY", + "GNU Taler Exchange", + "Taler payment service provider", + "Network applications", + ), + ( + "taler-challenger-manual", + "challenger", + "Taler Challenger Manual", + "GNU Taler team", + "GNU Taler Challenger", + "Customer address validation service", + "Network applications", ), ( "taler-merchant-manual", "taler-merchant", "Taler Merchant Manual", "GNU Taler team", - "MENU ENTRY", - "DESCRIPTION", - "CATEGORY", + "GNU Taler Merchant", + "Backend for merchants accepting Taler payments", + "Network applications", ), ( "taler-merchant-api-tutorial", "taler-merchant-api-tutorial", "Taler Merchant API Tutorial", "GNU Taler team", - "MENU ENTRY", - "DESCRIPTION", - "CATEGORY", + "GNU Taler Merchant API", + "Tutorial for using the merchant backend API", + "Network applications", ), ( "taler-developer-manual", "taler-developer-manual", "Taler Developer Manual", "GNU Taler team", - "MENU ENTRY", - "DESCRIPTION", - "CATEGORY", + "GNU Taler Development", + "Manual for GNU Taler contributors", + "Network applications", ), ] |