diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 34 |
1 files changed, 29 insertions, 5 deletions
@@ -1,10 +1,34 @@ This repository contains the documentation for all main GNU Taler components. -Before building the documentation, make sure that you have the required -dependencies installed using pip3: +To build things on a Debian (-based) system, install these packages: + - make + - python3-sphinx + - python3-recommonmark + - python3-sphinx-book-theme + - graphviz + - texlive-latex-extra + - dvipng -$ pip3 install --user --upgrade recommonmark sphinx +Then, do "make html" for HTML, "make texinfo" for Texinfo, etc. +(Do "make" w/o a target to see a list of possible targets.) -Note by Buck: when setting up on VM, I also needed: +The output is in subdir ‘_build’. -# apt install texlive-latex-extra graphviz + +Branch ‘prebuilt’ is special. Its contents (or a subset) are used as +submodules in other Git repos (e.g., Exchange, Merchant, Sync). + +One approach that works well (so far) for ttn is to do +(presuming that the current directory is named ‘docs’): + + $ cd .. + $ git clone -b prebuilt --reference docs \ + git+ssh://git@git.taler.net/docs.git \ + docs-prebuilt + +This creates Git repo docs-prebuilt as a peer to the current repo. + +This way, you can build in this directory (i.e., "make man" or whatever) +and then copy to ../docs-prebuilt/man/* what files need to be updated. +In that repo, you can commit changes and push to git.taler.net as normal, +all without having to do "git checkout" in either repo. |