kych

OAuth 2.0 API for Swiyu to enable Taler integration of Swiyu for KYC (experimental)
Log | Files | Refs | README | LICENSE

conf.py (2871B)

      1 # Sphinx configuration for building the KyCH man pages out of this repository.
      2 #
      3 # The reStructuredText in ../taler-docs/manpages/ is the single source for the
      4 # man pages.  On the website they are rendered by the taler-docs repository,
      5 # which has its own (much larger) conf.py; this file exists so that the same
      6 # sources can be turned into troff here, with nothing but python3-sphinx
      7 # installed, for the Debian package to install.
      8 #
      9 # It deliberately lives outside ../taler-docs/ so that directory stays a set of
     10 # files that can be copied into the taler-docs checkout without clobbering
     11 # anything of its own.
     12 #
     13 # Build with:
     14 #
     15 #     sphinx-build -b man -c documentation/sphinx-man \
     16 #         documentation/taler-docs/manpages <outdir>
     17 #
     18 # When these pages are upstreamed, the man_pages entries below have to be added
     19 # to taler-docs/conf.py as well, with a "manpages/" prefix on the first field.
     20 
     21 project = "KyCH"
     22 copyright = "2024-2026 Taler Systems SA"
     23 author = "GNU Taler contributors"
     24 
     25 # No extensions: the man page sources use only core directives ("only",
     26 # "code-block", "note").  Keep it that way, or this build grows dependencies.
     27 extensions = []
     28 
     29 # There is no index in the source directory -- it holds nothing but the three
     30 # man pages -- so nominate one of them as the root document.  Which one does
     31 # not matter for the man builder; each entry in man_pages below is rendered
     32 # from its own source file.
     33 root_doc = "kych-oauth2-gateway.1"
     34 
     35 # Building this way emits "document isn't included in any toctree" for the two
     36 # pages that are not the root document.  That is expected and harmless: the
     37 # toctree those pages belong to lives in the taler-docs repository, not here.
     38 # The warning carries no type, so suppress_warnings cannot switch it off, and
     39 # the alternative -- an ":orphan:" field in the shared sources -- would be a
     40 # lie once they are built as part of taler-docs.
     41 exclude_patterns = []
     42 
     43 # (source file without .rst, name, description, authors, manual section)
     44 #
     45 # The description becomes the NAME line of the generated page, which is why the
     46 # sources wrap their own "Name" section in ".. only:: html".  Keep the two
     47 # saying the same thing.
     48 man_pages = [
     49     (
     50         "kych-oauth2-gateway.1",
     51         "kych-oauth2-gateway",
     52         "OAuth 2.0 gateway for SWIYU credential verification",
     53         ["GNU Taler contributors"],
     54         1,
     55     ),
     56     (
     57         "kych-client-management.1",
     58         "kych-client-management",
     59         "manage OAuth 2.0 clients of the KyCH gateway",
     60         ["GNU Taler contributors"],
     61         1,
     62     ),
     63     (
     64         "kych.conf.5",
     65         "kych.conf",
     66         "configuration file of the KyCH OAuth 2.0 gateway",
     67         ["GNU Taler contributors"],
     68         5,
     69     ),
     70 ]
     71 
     72 # Spell out the target of a hyperlink instead of hiding it behind link text,
     73 # which a reader of a terminal cannot click.
     74 man_show_urls = True