taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

commit f35203265df635ceaa220a04a4d26fa36ebd869a
parent e54f385aa76a52c45dbf56a3282c8a080a6808df
Author: Florian Dold <florian@dold.me>
Date:   Wed, 18 Feb 2026 01:13:28 +0100

fix various warnings and issues

Diffstat:
MREADME | 2+-
Mchecklists/checklist-demo-upgrade.rst | 8+-------
Mchecklists/frags/checklist-wallet.rst | 5-----
Mconf.py | 24+++++++++---------------
Mcore/api-corebank.rst | 2+-
Mcore/auditor/get-monitoring-purses.rst | 2--
Mcore/merchant/get-orders-ORDER_ID.rst | 2+-
Mdeployments/tops.rst | 30+++++++++++++++---------------
Mdepolymerization/bitcoin-manual.rst | 6+++---
Mdesign-documents/053-wallet-ui.rst | 29++++++++++++-----------------
Mdesign-documents/054-dynamic-form.rst | 6------
Mdesign-documents/068-tokens-roadmap.rst | 4++--
Mdesign-documents/078-taxes.rst | 2+-
Mdeveloper/taler-developer-manual.rst | 6+++---
Mlibeufin/ebisync-manual.rst | 4++--
Mmanpages/libeufin-bank.conf.5.rst | 2+-
Mmanpages/libeufin-ebisync.conf.5.rst | 2+-
Mmanpages/libeufin-nexus.conf.5.rst | 2+-
Mregional/regional-automated-manual.rst | 2+-
Mtaler-directory-manual.rst | 2+-
20 files changed, 56 insertions(+), 86 deletions(-)

diff --git a/README b/README @@ -3,7 +3,7 @@ This repository contains the documentation for all main GNU Taler components. To build things on a Debian (-based) system, install these packages: - make - python3-sphinx - - python3-recommonmark + - python3-myst-parser - python3-sphinx-book-theme - graphviz - texlive-latex-extra diff --git a/checklists/checklist-demo-upgrade.rst b/checklists/checklist-demo-upgrade.rst @@ -3,11 +3,6 @@ GNU Taler Demo Upgrade Checklist .. toctree:: -.. |democheck| raw:: html - - <input type="checkbox"> - - Domains ------- @@ -107,4 +102,4 @@ Donation demo that the payment is requested again, instead of showing the previous fulfillment page. -.. include:: frags/checklist-common.rst -\ No newline at end of file +.. include:: frags/checklist-common.rst diff --git a/checklists/frags/checklist-wallet.rst b/checklists/frags/checklist-wallet.rst @@ -1,8 +1,3 @@ - -.. |democheck| raw:: html - - <input type="checkbox"> - Wallets ------- diff --git a/conf.py b/conf.py @@ -47,7 +47,7 @@ sys.path.append(os.path.abspath("_exts")) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "5.2.0" +needs_sphinx = "8.0.0" # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -59,7 +59,7 @@ extensions = [ "sphinx.ext.graphviz", "sphinx.ext.imgmath", "httpdomain.httpdomain", - "recommonmark", + "myst_parser", "sphinx_multitoc_numbering", ] @@ -1105,17 +1105,11 @@ graphviz_output_format = "svg" myst_heading_anchors = 3 myst_enable_extensions = [ - "amsmath", - "colon_fence", - "deflist", - "dollarmath", - "fieldlist", - "html_admonition", - "html_image", - "linkify", - "replacements", - "smartquotes", - "strikethrough", - "substitution", - "tasklist", ] + + +rst_prolog = """ +.. |democheck| raw:: html + + <input type="checkbox"> +""" diff --git a/core/api-corebank.rst b/core/api-corebank.rst @@ -1665,7 +1665,7 @@ Requesting challenges :http:statuscode:`404 Not Found`: * ``TALER_EC_BANK_TAN_CHANNEL_SCRIPT_FAILED``: TAN transmition failed. * ``TALER_EC_BANK_TAN_CHALLENGE_EXPIRED``: TAN transmition failed. - The challenge was not found. + The challenge was not found. :http:statuscode:`410 Gone`: The challenge was already solved. :http:statuscode:`429 Too many requests`: diff --git a/core/auditor/get-monitoring-purses.rst b/core/auditor/get-monitoring-purses.rst @@ -42,5 +42,3 @@ .. note:: This endpoint is still experimental. The endpoint will be further developed as needed. - - .. _progress-list: diff --git a/core/merchant/get-orders-ORDER_ID.rst b/core/merchant/get-orders-ORDER_ID.rst @@ -43,7 +43,7 @@ Returned only for unauthenticated (no nonce, no contract hash) requests and only if the order was claimed already. Only returned if the content type requested was not HTML, - if HTML was requested a `302 Found` will be returned instead. + if HTML was requested a ``302 Found`` will be returned instead. The target site may allow the client to setup a fresh order (as this one has been taken) or may trigger repurchase detection. diff --git a/deployments/tops.rst b/deployments/tops.rst @@ -608,7 +608,7 @@ accept-tos **Purpose:** Customer confirms that they accept the terms of service. -**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-accept%20tos-EmptyForm>`_ +**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-accept%20tos-EmptyForm>`__ **Attributes**: @@ -634,7 +634,7 @@ generic_note **Purpose:** Free-form note. Should be used instead of the ``FILE_NOTE`` when there are attachements or the note contains very sensitive information. -**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-generic_note-EmptyForm>`_ +**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-generic_note-EmptyForm>`__ **Attributes**: @@ -653,7 +653,7 @@ generic_upload **Purpose:** Free-form upload. The type/name of the requested document is taken from the context. -**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-generic_upload-EmptyForm>`_ +**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-generic_upload-EmptyForm>`__ **Context:** @@ -676,7 +676,7 @@ vqf_902_1_customer **Purpose:** Initial collection of basic attributes about customer during onboarding. -**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-vqf_902_1_customer-EmptyForm>`_ +**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-vqf_902_1_customer-EmptyForm>`__ **Remarks:** @@ -996,7 +996,7 @@ vqf_902_4 **Purpose:** The AML officer uses this form to document the risk profile of a customer. -**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-vqf_902_4-EmptyForm>`_ +**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-vqf_902_4-EmptyForm>`__ **Differences from VQF form** @@ -1322,7 +1322,7 @@ vqf_902_5 **Purpose:** Customer profile -**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-vqf_902_5-EmptyForm>`_ +**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-vqf_902_5-EmptyForm>`__ **Differences from VQF form:** @@ -1470,7 +1470,7 @@ vqf_902_9_customer **Purpose:** Establish the identity of the beneficial owner. -**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-vqf_902_9_customer-EmptyForm>`_ +**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-vqf_902_9_customer-EmptyForm>`__ **Differences from VQF form 902.9:** @@ -1566,7 +1566,7 @@ vqf_902_9_officer **Purpose:** Establish the identity of the beneficial owner. -**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-VQF_902_9_officer-EmptyForm>`_ +**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-VQF_902_9_officer-EmptyForm>`__ **Differences from VQF form 902.9:** @@ -1655,7 +1655,7 @@ vqf_902_11_customer **Purpose:** Determine the controlling person of an operational legal entity or partnership. -**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-vqf_902_11_customer-EmptyForm>`_ +**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-vqf_902_11_customer-EmptyForm>`__ **Differences from VQF form 902.11:** @@ -1784,7 +1784,7 @@ vqf_902_11_officer **Purpose:** Determine the controlling person of an operational legal entity or partnership. -**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-vqf_902_11_officer-EmptyForm>`_ +**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-vqf_902_11_officer-EmptyForm>`__ **Differences from VQF form 902.11:** @@ -1917,7 +1917,7 @@ vqf_902_14 **Purpose**: Special clarifications regarding the customer. This form is filled out by at the initiative of the AML officer or in response to an alert. -**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-vqf_902_14-EmptyForm>`_ +**Form Demo:** `Link <https://www.taler.net/files/storybook-forms/stories.html#forms-vqf_902_14-EmptyForm>`__ **Attributes:** @@ -2505,7 +2505,7 @@ FAQ References ---------- -* Taler-Exchange AML flows (`git <https://git.taler.net/exchange.git/tree/doc/flows/main.tex>`_, `PDF <http://taler.net/files/taler-exchange-flows.pdf>`_) -* VQF forms (`VQF Website <https://www.vqf.ch/de/vqf-downloads>`_) -* GANA form attributes (`git <https://git.taler.net/gana.git/tree/gnu-taler-form-attributes/registry.rec>`_) -* taler-typescript-core forms implementation (`git <https://git.taler.net/taler-typescript-core.git/tree/packages/web-util/src/forms/gana>`_) +* Taler-Exchange AML flows (`git <https://git.taler.net/exchange.git/tree/doc/flows/main.tex>`_, `PDF <http://taler.net/files/taler-exchange-flows.pdf>`__) +* VQF forms (`VQF Website <https://www.vqf.ch/de/vqf-downloads>`__) +* GANA form attributes (`git <https://git.taler.net/gana.git/tree/gnu-taler-form-attributes/registry.rec>`__) +* taler-typescript-core forms implementation (`git <https://git.taler.net/taler-typescript-core.git/tree/packages/web-util/src/forms/gana>`__) diff --git a/depolymerization/bitcoin-manual.rst b/depolymerization/bitcoin-manual.rst @@ -32,7 +32,7 @@ Installation of the Bitcoin Depolymerizer Installing on Debian -------------------- -.. include:: frags/installing-debian.rst +.. include:: ../frags/installing-debian.rst To install the depolymerizer, you can now simply run: @@ -43,7 +43,7 @@ To install the depolymerizer, you can now simply run: Installing on Ubuntu -------------------- -.. include:: frags/installing-ubuntu.rst +.. include:: ../frags/installing-ubuntu.rst To install the depolymerizer, you can now simply run: @@ -213,7 +213,7 @@ can use the ``depolymerizer-bitcoin config`` helper: # depolymerizer-bitcoin config dump --diagnostics -.. include:: frags/configuration-format.rst +.. include:: ../frags/configuration-format.rst Bitcoin Depolymerizer Setup =========================== diff --git a/design-documents/053-wallet-ui.rst b/design-documents/053-wallet-ui.rst @@ -381,7 +381,7 @@ Screenshots +-----------+------------------------------------------------------------------------+ | Platform | Screenshot | +===========+========================================================================+ -| WebEx | .. image:: ../screenshots/cta-transactions-pending-firefox-latest.png | +| WebEx | FIXME | +-----------+------------------------------------------------------------------------+ | Android | .. image:: ../screenshots/cta-transactions-pending-android-latest.png | | | :width: 30% | @@ -639,7 +639,7 @@ Actions +-----------+------------------------------------------------------------------------+ | Platform | Screenshot | +===========+========================================================================+ -| WebEx | .. image:: ../screenshots/cta-wire-transfer-details-firefox-latest.png | +| WebEx | FIXME | +-----------+------------------------------------------------------------------------+ | Android | .. image:: ../screenshots/cta-wire-transfer-details-android-latest.png | | | :width: 30% | @@ -671,7 +671,7 @@ Actions +-----------+------------------------------------------------------------------+ | Platform | Screenshot | +===========+==================================================================+ -| WebEx | .. image:: ../screenshots/cta-wire-transfer-qr-firefox-latest.png| +| WebEx | FIXME | +-----------+------------------------------------------------------------------+ | Android | .. image:: ../screenshots/cta-wire-transfer-qr-android-latest.png| | | :width: 30% | @@ -770,7 +770,7 @@ Screenshots +-----------+------------------------------------------------------------------+ | Platform | Screenshot | +===========+==================================================================+ -| WebEx | .. image:: ../screenshots/cta-withdraw-kyc-firefox-latest.png | +| WebEx | FIXME | +-----------+------------------------------------------------------------------+ | Android | .. image:: ../screenshots/cta-withdraw-kyc-android-latest.png | | | :width: 30% | @@ -1077,13 +1077,13 @@ Screenshots +-----------+------------------------------------------------------------------+ | Platform | Screenshot | +===========+==================================================================+ -| WebEx | .. image:: ../screenshots/cta-bank-accounts-firefox-latest.png | +| WebEx | FIXME | +-----------+------------------------------------------------------------------+ | Android | .. image:: ../screenshots/cta-bank-accounts-android-latest.png | | | :width: 30% | +-----------+------------------------------------------------------------------+ -| iOS | .. image:: ../screenshots/cta-bank-accounts-ios-latest.png | -| | :width: 30% | +| iOS | FIXME | +| | | +-----------+------------------------------------------------------------------+ .. _cta-bank-account-edit-ref: @@ -1094,14 +1094,12 @@ cta-bank-account-edit +-----------+---------------------------------------------------------------------+ | Platform | Screenshot | +===========+=====================================================================+ -| WebEx | .. image:: ../screenshots/cta-bank-account-edit-firefox-latest.png | -| | | +| WebEx | FIXME | +-----------+---------------------------------------------------------------------+ | Android | .. image:: ../screenshots/cta-bank-account-edit-android-latest.png | | | :width: 30% | +-----------+---------------------------------------------------------------------+ -| iOS | .. image:: ../screenshots/cta-bank-account-edit-ios-latest.png | -| | :width: 30% | +| iOS | FIXME | +-----------+---------------------------------------------------------------------+ .. _cta-peer-pull-initiate-ref: @@ -1362,8 +1360,7 @@ Screenshots +-----------+----------------------------------------------------------------------+ | Platform | Screenshot | +===========+======================================================================+ -| WebEx | .. image:: ../screenshots/cta-accept-tos-language-firefox-latest.png | -| | :width: 30% | +| WebEx | FIXME | +-----------+----------------------------------------------------------------------+ | Android | .. image:: ../screenshots/cta-accept-tos-language-android-latest.png | | | :width: 30% | @@ -1433,8 +1430,7 @@ Screenshots +-----------+-------------------------------------------------------------------+ | Platform | Screenshot | +===========+===================================================================+ -| WebEx | .. image:: ../screenshots/cta-exchange-loading-firefox-latest.png | -| | :width: 30% | +| WebEx | FIXME | +-----------+-------------------------------------------------------------------+ | Android | .. image:: ../screenshots/cta-exchange-loading-android-latest.png | | | :width: 30% | @@ -1473,8 +1469,7 @@ Screenshots | Android | .. image:: ../screenshots/cta-developer-tools-android-latest.png | | | :width: 30% | +-----------+-------------------------------------------------------------------+ -| iOS | .. image:: ../screenshots/cta-developer-tools-ios-latest.png | -| | :width: 30% | +| iOS | FIXME | +-----------+-------------------------------------------------------------------+ Q / A diff --git a/design-documents/054-dynamic-form.rst b/design-documents/054-dynamic-form.rst @@ -594,9 +594,6 @@ Number input } & UIFormFieldBaseConfig; -.. image:: ../screenshots/dynamic-forms.number.png - :width: 400 - Text input `````````` @@ -613,9 +610,6 @@ A bigger multi-line of text type UIFormFieldTextArea = { type: "textArea" } & UIFormFieldBaseConfig; -.. image:: ../screenshots/dynamic-forms.text.png - :width: 400 - Boolean input ````````````` diff --git a/design-documents/068-tokens-roadmap.rst b/design-documents/068-tokens-roadmap.rst @@ -156,7 +156,7 @@ User Experience =============== Donau MVP -^^^^^^^^^ +~~~~~~~~~ **Donor / wallet user:** @@ -180,7 +180,7 @@ In the MVP, the merchant backend will be set up via the REST API, we won't provide any SPA support. Donau Next Iteration -^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~ **Donor / wallet user:** diff --git a/design-documents/078-taxes.rst b/design-documents/078-taxes.rst @@ -142,7 +142,7 @@ given product or order. (8) rounding mode (up, down, nearest) (9) rounding unit (amount) (10) money pot (where to accumulate taxes paid under this tax class). - to track known tax rules. Unique should be "instance+tax class name". + to track known tax rules. Unique should be "instance+tax class name". * When "rounding up" is used, round up from net to gross, but round down from gross to net. Similarly, when "rounding down" is used, diff --git a/developer/taler-developer-manual.rst b/developer/taler-developer-manual.rst @@ -701,13 +701,13 @@ outside of this versioning. All tables of a GNU Taler component should live in QA Plans ======== -.. include:: checklists/qa-1.0.rst +.. include:: ../checklists/qa-1.0.rst Releases ======== -.. include:: checklists/checklist-release.rst +.. include:: ../checklists/checklist-release.rst Release Process --------------- @@ -743,7 +743,7 @@ For tests in the exchange and merchant to run, make sure that a database *talercheck* is accessible by *$USER*. Otherwise tests involving the database logic are skipped. -.. include:: frags/db-stores-sensitive-data.rst +.. include:: ../frags/db-stores-sensitive-data.rst Exchange, merchant ------------------ diff --git a/libeufin/ebisync-manual.rst b/libeufin/ebisync-manual.rst @@ -123,8 +123,8 @@ is: .. code-block:: ini :caption: /etc/libeufin-ebisync/secrets/ebisync-db.secret.conf - [ebisyncdb-postgres] - config = postgres:///libeufin-ebisync + [ebisyncdb-postgres] + config = postgres:///libeufin-ebisync You must make sure that this database exists and is accessible to the user running EbiSync before continuing. Then, the EbiSync database schema must be diff --git a/manpages/libeufin-bank.conf.5.rst b/manpages/libeufin-bank.conf.5.rst @@ -145,7 +145,7 @@ DATABASE OPTIONS Setting the database belongs to the “[libeufin-bankdb-postgres]” section and the following value. -.. include:: frags/common-db-options.rs +.. include:: frags/common-db-options.rst SEE ALSO ======== diff --git a/manpages/libeufin-ebisync.conf.5.rst b/manpages/libeufin-ebisync.conf.5.rst @@ -132,7 +132,7 @@ DATABASE OPTIONS Setting the database belongs to the “[ebisyncdb-postgres]” section and the following value. -.. include:: frags/common-db-options.rs +.. include:: ../frags/common-db-options.rst SEE ALSO ======== diff --git a/manpages/libeufin-nexus.conf.5.rst b/manpages/libeufin-nexus.conf.5.rst @@ -175,7 +175,7 @@ DATABASE OPTIONS Setting the database belongs to the “[libeufin-nexusdb-postgres]” section and the following value. -.. include:: frags/common-db-options.rs +.. include:: frags/common-db-options.rst SEE ALSO ======== diff --git a/regional/regional-automated-manual.rst b/regional/regional-automated-manual.rst @@ -166,7 +166,7 @@ with various credentials. Those must be provided in the The following snippet shows the mandatory configuration values: -.. _core-config: +.. _regio-nexus-core-config: .. code-block:: ini diff --git a/taler-directory-manual.rst b/taler-directory-manual.rst @@ -93,7 +93,7 @@ For the GNS disseminator, a running GNUnet installation is also required: .. include:: frags/installing-taler-merchant.rst -.. include:: frags/installing-taldir.rst +**FIXME: Instructions for installing taldir** .. include:: frags/install-before-check.rst