README.md

   1 Koha Documentation
   2 ==================
   3
   4 This is the main repository for the Koha manual.
   5 It is mirrored at git.koha-community.org.
   6
   7 The manual is generated with Sphinx.
   8
   9 Setup
  10 -----
  11
  12 > sudo apt-get install python3-sphinx  python3-sphinxcontrib.spelling
  13
  14 Outputing Docs
  15 --------------
  16
  17 ### For HTML
  18 > make html
  19
  20 ### For HTML in a single page
  21 >  make singlehtml
  22
  23 ### For an epub
  24 >  make epub
  25
  26 ### For a pdf (Work in progress)
  27
  28 Install latexmk, the latexpdf builder needs it
  29
  30 > apt install latexmk
  31
  32 Install texlive-full. Attention: this is very huge
  33
  34 > apt install texlive-full
  35
  36 Generate the latex files
  37
  38 > make latex
  39
  40 Generate the PDF file
  41
  42 > make latexpdf
  43
  44
  45 Other useful commands
  46 ---------------------
  47
  48 To find everything that you can do, you can just do
  49
  50 > make
  51
  52 And it will list all the available options. Some useful ones are
  53
  54 ### Check spelling
  55 > make spelling
  56
  57 ### Check links in the documentation
  58 > make linkcheck
  59
  60 ### Generate .po files for translation
  61 > make gettext