taler-docs

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

README (1176B)

      1 This repository contains the documentation for all main GNU Taler components.
      2 
      3 To build things on a Debian (-based) system, install these packages:
      4  - make
      5  - python3-sphinx
      6  - python3-myst-parser
      7  - python3-sphinx-book-theme
      8  - python3-sphinx-design
      9  - graphviz
     10  - texlive-latex-extra
     11  - dvipng
     12 
     13 Then, do "make html" for HTML, "make texinfo" for Texinfo, etc.
     14 (Do "make" w/o a target to see a list of possible targets.)
     15 
     16 The output is in subdir ‘_build’.
     17 
     18 
     19 Branch ‘prebuilt’ is special.  Its contents (or a subset) are used as
     20 submodules in other Git repos (e.g., Exchange, Merchant, Sync).
     21 
     22 One approach that works well (so far) for ttn is to do
     23 (presuming that the current directory is named ‘docs’):
     24 
     25  $ cd ..
     26  $ git clone -b prebuilt --reference docs \
     27      git+ssh://git@git.taler.net/docs.git \
     28      docs-prebuilt
     29 
     30 This creates Git repo docs-prebuilt as a peer to the current repo.
     31 
     32 This way, you can build in this directory (i.e., "make man" or whatever)
     33 and then copy to ../docs-prebuilt/man/* what files need to be updated.
     34 In that repo, you can commit changes and push to git.taler.net as normal,
     35 all without having to do "git checkout" in either repo.