README.md

   1 Koha Documentation
   2 ==================
   3
   4 This is the Koha Documentation Repository
   5
   6 Documentation is generated with Sphinx.
   7
   8 Setup
   9 -----
  10
  11 > sudo apt-get install python3-sphinx  python3-sphinxcontrib.spelling
  12
  13 Outputing Docs
  14 --------------
  15
  16 ### For HTML
  17 > make html
  18
  19 ### For HTML in a single page
  20 >  make singlehtml
  21
  22 ### For an epub
  23 >  make epub
  24
  25 ### For a pdf (Work in progress)
  26 > apt install latexmk # the latexpdf builder needs it
  27 > apt install texlive-full # Attention, this is very huge
  28                            # We should to list the individual packages we need
  29 > make latex # Generate the latex files
  30 > make latexpdf # Will generate the pdf file
  31
  32
  33 Other useful commands
  34 ---------------------
  35
  36 To find everything that you can do, you can just do
  37
  38 > make
  39
  40 And it will list all the available options. Some useful ones are
  41
  42 ### Check spelling
  43 > make spelling
  44
  45 ### Check links in the documentation
  46 > make linkcheck
  47
  48 ### Generate .po files for translation
  49 > make gettext
  50
  51