commit e1c9dcf8a185b3bc5547fc707eb01045985b4a48 parent 7e537aa45c958a99f051ad5fefcc153ec5a4d0ba Author: Özgür Kesim <oec-taler@kesim.org> Date: Tue, 16 Dec 2025 22:58:32 +0100 [layout] remove local tocs; add grouping to navbar added sphinx_multitoc_numbering extension; slight reorg Diffstat:
41 files changed, 62 insertions(+), 178 deletions(-)
diff --git a/_static/custom.css b/_static/custom.css @@ -2,7 +2,7 @@ .container { max-width: 100rem; } - + .bd-sidebar { flex-basis: 25%; } @@ -13,3 +13,8 @@ max-width: 25%; } } + +.section-number { + color:grey; + font-size: medium; +} diff --git a/conf.py b/conf.py @@ -56,10 +56,11 @@ extensions = [ "ebicsdomain", "typescriptdomain", "sphinx.ext.todo", + "sphinx.ext.graphviz", "sphinx.ext.imgmath", "httpdomain.httpdomain", "recommonmark", - "sphinx.ext.graphviz", + "sphinx_multitoc_numbering", ] imgmath_image_format = 'svg' @@ -130,7 +131,8 @@ default_role = "ts:type" # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -# show_authors = False +show_authors = False +author = 'GNU Taler Developers' # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" diff --git a/core/api-auditor.rst b/core/api-auditor.rst @@ -24,9 +24,6 @@ for all details not specified in the individual requests. The `glossary <https://docs.taler.net/taler-developer-manual.html#developer-glossary>`_ defines all specific terms used in this section. -.. contents:: Table of Contents - :local: - .. _authentication: -------------- diff --git a/core/api-bank-conversion-info.rst b/core/api-bank-conversion-info.rst @@ -26,8 +26,6 @@ This chapter describes the conversion info API. The conversion info API is used by wallets for withdrawals that involve a currency conversion. -.. contents:: Table of Contents - .. http:get:: /config Return the protocol version and configuration information about the bank. diff --git a/core/api-bank-integration.rst b/core/api-bank-integration.rst @@ -24,8 +24,6 @@ Taler Bank Integration API This chapter describe the APIs that banks need to offer towards Taler wallets to tightly integrate with GNU Taler. -.. contents:: Table of Contents - .. http:get:: /config Return the protocol version and configuration information about the bank. diff --git a/core/api-common.rst b/core/api-common.rst @@ -19,15 +19,10 @@ .. _http-common: -.. _foo_bar: - ================================== Conventions for Taler RESTful APIs ================================== -.. contents:: Table of Contents - :local: - ------------------------- HTTP Request and Response ------------------------- diff --git a/core/api-corebank.rst b/core/api-corebank.rst @@ -22,9 +22,6 @@ Taler Core Bank API ==================== -.. contents:: Table of Contents - :local: - Introduction ------------ diff --git a/core/api-donau.rst b/core/api-donau.rst @@ -29,9 +29,6 @@ for all details not specified in the individual requests. The `glossary <https://docs.taler.net/taler-developer-manual.html#developer-glossary>`_ defines all specific terms used in this section. -.. contents:: Table of Contents - :local: - .. _donau-overview: ------------ diff --git a/core/api-exchange.rst b/core/api-exchange.rst @@ -16,9 +16,9 @@ @author Christian Grothoff @author Özgür Kesim -======================== -The Exchange RESTful API -======================== +==================== +Exchange RESTful API +==================== The API specified here follows the :ref:`general conventions <http-common>` for all details not specified in the individual requests. diff --git a/core/api-mailbox.rst b/core/api-mailbox.rst @@ -36,9 +36,6 @@ for all details not specified in the individual requests. The `glossary <https://docs.taler.net/taler-developer-manual.html#developer-glossary>`_ defines all specific terms used in this section. -.. contents:: Table of Contents - :local: - .. include:: tos.rst ------------------------- diff --git a/core/api-observability.rst b/core/api-observability.rst @@ -22,9 +22,6 @@ Taler Observability API ======================= -.. contents:: Table of Contents - :local: - Introduction ------------ @@ -70,4 +67,4 @@ Metrics :http:statuscode:`200 Ok`: Response woth metrics in the Prometheus text format. :http:statuscode:`401 Unauthorized`: - Authentication failed, likely the credentials are wrong. -\ No newline at end of file + Authentication failed, likely the credentials are wrong. diff --git a/core/api-taldir.rst b/core/api-taldir.rst @@ -38,9 +38,6 @@ for all details not specified in the individual requests. The `glossary <https://docs.taler.net/taler-developer-manual.html#developer-glossary>`_ defines all specific terms used in this section. -.. contents:: Table of Contents - :local: - .. include:: tos.rst diff --git a/depolymerization/bitcoin-manual.rst b/depolymerization/bitcoin-manual.rst @@ -26,9 +26,6 @@ operate a Bictoin GNU Taler Depolymerizer In this manual, we explain how to setup a depolymerizer. -.. contents:: Table of Contents - :local: - Installation of the Bitcoin Depolymerizer ========================================= @@ -517,4 +514,4 @@ Launching the depolymerizer .. code-block:: console - $ sudo systemctl start depolymerizer-bitcoin.target -\ No newline at end of file + $ sudo systemctl start depolymerizer-bitcoin.target diff --git a/index.rst b/index.rst @@ -19,7 +19,9 @@ @author Marcello Stanisci @author Christian Grothoff @author Javier Sepulveda + @author Özgür Kesim +======================= GNU Taler Documentation ======================= @@ -48,36 +50,56 @@ Tutorials are available `here <https://tutorials.taler.net/>`_. They demonstrate and overall usage of the different Taler components in text and video formats. -Documentation Overview ----------------------- - .. toctree:: - :numbered: :maxdepth: 1 + :hidden: + :numbered: + :caption: For Operators - core/index - taler-merchant-manual - taler-merchant-pos-terminal - taler-wallet taler-exchange-manual taler-kyc-manual taler-challenger-manual + taler-merchant-manual + taler-merchant-pos-terminal + libeufin/index + taler-magnet-bank-manual + taler-cyclos-manual taler-auditor-manual taler-directory-manual taler-mailbox-manual - taler-magnet-bank-manual - taler-cyclos-manual - libeufin/index depolymerization/index + manindex + + +.. toctree:: + :maxdepth: 1 + :hidden: + :numbered: + :caption: For Developers + + core/index design-documents/index + taler-wallet taler-developer-manual - system-administration/index - global-licensing - manindex - genindex + .. toctree:: :hidden: + :numbered: + :class: toc-lic + :caption: Licensing + global-licensing fdl-1.3 + +.. toctree:: + :maxdepth: 1 + :hidden: + :numbered: + :class: toc-other + :caption: Other + + system-administration/index tutorials + genindex + diff --git a/libeufin/bank-manual.rst b/libeufin/bank-manual.rst @@ -30,10 +30,6 @@ and REST APIs to interact with GNU Taler components. In this manual, we explain how to setup a bank. -.. contents:: Table of Contents - :local: - - Installing LibEuFin Bank ======================== diff --git a/libeufin/ebisync-manual.rst b/libeufin/ebisync-manual.rst @@ -30,10 +30,6 @@ tested with Postfinance (CHF), GLS (EUR), Maerki Baumann (CHF) and Valiant (CHF) In this manual, we explain how to setup an EBICS subscriber. We assume that the bank has already granted EBICS access to the subscriber. -.. contents:: Table of Contents - :local: - - Installing EbiSync ================== @@ -356,4 +352,4 @@ Launching .. code-block:: console - $ sudo systemctl start taler-ebisync.target -\ No newline at end of file + $ sudo systemctl start taler-ebisync.target diff --git a/libeufin/nexus-dialects.rst b/libeufin/nexus-dialects.rst @@ -29,9 +29,6 @@ that banks tend to have their own dialects of finance messages and thus other retail banks may or may not work. Contact us if you need support for another bank or core banking protocol. -.. contents:: Table of Contents - :local: - EBICS ===== @@ -97,4 +94,4 @@ Instant direct debits are always tried first if they are supported, and LibEuFin The following pain.001 format are used: - postfinance & maerki_baumann & valiant: pain.001.001.09.ch.03 with the default service level this will only work between swiss accounts -- gls: pain.001.001.09 with the SEPA service level this works with any other SEPA account -\ No newline at end of file +- gls: pain.001.001.09 with the SEPA service level this works with any other SEPA account diff --git a/libeufin/nexus-manual.rst b/libeufin/nexus-manual.rst @@ -37,10 +37,6 @@ bank or core banking protocol. In this manual, we explain how to setup an EBICS subscriber. We assume that the bank has already granted EBICS access to the subscriber. -.. contents:: Table of Contents - :local: - - Installing Nexus ================ @@ -410,4 +406,4 @@ To import CAMT files, you can run: $ libeufin-nexus manual import -c "$CONFIG_FILE" camt53.xml -Files will be processed as if they had been downloaded using the EBICS protocol. -\ No newline at end of file +Files will be processed as if they had been downloaded using the EBICS protocol. diff --git a/libeufin/regional-automated-manual.rst b/libeufin/regional-automated-manual.rst @@ -25,10 +25,6 @@ Regional Currency Automated Setup Manual This manual describes how to setup a regional currency using a script that largely automates the process. If you want to do a custom setup you can follow the :doc:`custom setup manual<regional-custom-manual>`. - -.. contents:: Table of Contents - :local: - .. include:: ../frags/regional-manual-architecture.rst Guided Automated Setup diff --git a/libeufin/regional-custom-manual.rst b/libeufin/regional-custom-manual.rst @@ -25,9 +25,6 @@ Regional Currency Custom Setup Manual This manual describes how to setup a regional currency manually. If you want a guided setup you can follow the :doc:`automated setup manual<regional-automated-manual>`. -.. contents:: Table of Contents - :local: - .. include:: ../frags/regional-manual-architecture.rst Custom Manual Setup diff --git a/manindex.rst b/manindex.rst @@ -1,5 +1,5 @@ -Man Pages -######### +UNIX Man Pages +############## .. toctree:: :maxdepth: 1 diff --git a/system-administration/grafana-backup.rst b/system-administration/grafana-backup.rst @@ -18,10 +18,6 @@ Grafana backup ############## -.. contents:: Table of Contents - :depth: 1 - :local: - Backup grafana configuration file ================================= diff --git a/system-administration/grafana-loki.rst b/system-administration/grafana-loki.rst @@ -22,11 +22,6 @@ Grafana Loki Loki is an aggregation system really similar to Prometheus, but instead of reading metrics, it reads logs (via push). Please check the `official documentation website <https://grafana.com/docs/loki/latest/get-started/>`_ for additional information. - -.. contents:: Table of Contents - :depth: 1 - :local: - Create a system user ==================== diff --git a/system-administration/grafana-promtail.rst b/system-administration/grafana-promtail.rst @@ -22,11 +22,6 @@ Official documentation website can be found `here <https://grafana.com/docs/loki Promtail can read two different types of logs. Regular log files, or information from the Systemd journald. -.. contents:: Table of Contents - :depth: 1 - :local: - - Download promtail ================= diff --git a/system-administration/index.rst b/system-administration/index.rst @@ -15,8 +15,8 @@ @author Javier Sepulveda -System Administration Manual -############################ +Internal System Administration +############################## .. toctree:: :maxdepth: 1 diff --git a/system-administration/nginx-prometheus-exporter.rst b/system-administration/nginx-prometheus-exporter.rst @@ -19,10 +19,6 @@ Nginx Prometheus Exporter ######################### -.. contents:: Table of Contents - :depth: 1 - :local: - Download nginx-prometheus-exporter ================================== diff --git a/system-administration/prometheus-alerts.rst b/system-administration/prometheus-alerts.rst @@ -18,10 +18,6 @@ Prometheus alerts ################# -.. contents:: Table of Contents - :depth: 1 - :local: - The Prometheus alert manager does periodically queries defined in the alert rules files. In the event that any of these conditions are met, then the alerting system will send a notification (i.e email), directly to the specified contact points, or towards a specific group of contact points (these are named notification policies). diff --git a/system-administration/prometheus-node-exporter.rst b/system-administration/prometheus-node-exporter.rst @@ -19,11 +19,6 @@ Prometheus node-exporter ######################## -.. contents:: Table of Contents - :depth: 1 - :local: - - Create a system user ==================== diff --git a/system-administration/prometheus-postgres-exporter.rst b/system-administration/prometheus-postgres-exporter.rst @@ -19,11 +19,6 @@ Prometheus postgres-exporter ############################ -.. contents:: Table of Contents - :depth: 1 - :local: - - Create a system user ==================== diff --git a/system-administration/prometheus.rst b/system-administration/prometheus.rst @@ -18,10 +18,6 @@ Installation of Prometheus ########################## -.. contents:: Table of Contents - :depth: 1 - :local: - Download Prometheus =================== diff --git a/taler-auditor-manual.rst b/taler-auditor-manual.rst @@ -20,11 +20,6 @@ Auditor Operator Manual ####################### -.. contents:: Table of Contents - :depth: 1 - :local: - - Introduction ============ diff --git a/taler-challenger-manual.rst b/taler-challenger-manual.rst @@ -20,11 +20,6 @@ Challenger Operator Manual ########################## -.. contents:: Table of Contents - :depth: 2 - :local: - - Introduction ============ diff --git a/taler-developer-manual.rst b/taler-developer-manual.rst @@ -19,17 +19,11 @@ Developer's Manual ################## -.. toctree:: - .. note:: This manual contains information for developers working on GNU Taler and related components. It is not intended for a general audience. -.. contents:: Table of Contents - :depth: 2 - :local: - Project Overview ================ @@ -47,7 +41,8 @@ overview: used by banks in the EU. Allows an exchange to interact with European banks. -* taler-magnet-bank: implementation of the "bank" API using the Magnet Bank API.Allows an exchange to interact with Magnet Bank. +* taler-magnet-bank: implementation of the "bank" API using the Magnet Bank + API.Allows an exchange to interact with Magnet Bank. * taler-cyclos: implementation of the "bank" API using the Cyclos API. Allows an exchange to interact with a Cyclos network. diff --git a/taler-directory-manual.rst b/taler-directory-manual.rst @@ -19,11 +19,6 @@ Directory Operator Manual ######################### -.. contents:: Table of Contents - :depth: 2 - :local: - - Introduction ============ diff --git a/taler-exchange-manual.rst b/taler-exchange-manual.rst @@ -20,11 +20,6 @@ Exchange Operator Manual ######################## -.. contents:: Table of Contents - :depth: 1 - :local: - - Introduction ============ diff --git a/taler-kyc-manual.rst b/taler-kyc-manual.rst @@ -22,11 +22,6 @@ Exchange KYC/AML Operator Manual ################################ -.. contents:: Table of Contents - :depth: 1 - :local: - - Introduction ============ diff --git a/taler-magnet-bank-manual.rst b/taler-magnet-bank-manual.rst @@ -24,10 +24,6 @@ taler-magnet-bank is a Magnet Bank Taler adapter. This manual targets system administrators who want to install and operate a Magnet Bank GNU Taler adapter -.. contents:: Table of Contents - :depth: 1 - :local: - Installation ============ @@ -255,4 +251,4 @@ Launching the adapter .. code-block:: console - $ sudo systemctl start taler-magnet-bank.target -\ No newline at end of file + $ sudo systemctl start taler-magnet-bank.target diff --git a/taler-mailbox-manual.rst b/taler-mailbox-manual.rst @@ -19,11 +19,6 @@ Mailbox Operator Manual ####################### -.. contents:: Table of Contents - :depth: 2 - :local: - - Introduction ============ diff --git a/taler-merchant-manual.rst b/taler-merchant-manual.rst @@ -21,10 +21,6 @@ Merchant Backend Operator Manual ################################ -.. contents:: Table of Contents - :depth: 1 - :local: - Introduction ============ diff --git a/taler-merchant-pos-terminal.rst b/taler-merchant-pos-terminal.rst @@ -26,10 +26,6 @@ The GNU Taler merchant point of sale (POS) App allows sellers to * calculate the amount owed by the customer * let the customer make a Taler payment via QR code or NFC -.. contents:: Table of Contents - :depth: 1 - :local: - Android App =========== diff --git a/taler-wallet.rst b/taler-wallet.rst @@ -19,10 +19,6 @@ Wallet Developer Manual The GNU Taler wallet allows customers to withdraw and spend digital cash. -.. contents:: Table of Contents - :depth: 1 - :local: - WebExtension Wallet ===================