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 > cd en/
  17
  18 ### For HTML
  19 > make html
  20
  21 ### For HTML in a single page
  22 >  make singlehtml
  23
  24 ### For an epub
  25 >  make epub
  26
  27 Other useful commands
  28 ---------------------
  29
  30 To find everything that you can do, you can just do
  31 > cd en/
  32
  33 > make
  34
  35 And it will list all the available options. Some useful ones are
  36
  37 ### Check spelling
  38 > make spelling
  39
  40 ### Check links in the documentation
  41 > make linkcheck
  42
  43 ### Generate .po files for translation
  44 > make gettext
  45
  46