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 Other useful commands
  26 ---------------------
  27
  28 To find everything that you can do, you can just do
  29
  30 > make
  31
  32 And it will list all the available options. Some useful ones are
  33
  34 ### Check spelling
  35 > make spelling
  36
  37 ### Check links in the documentation
  38 > make linkcheck
  39
  40 ### Generate .po files for translation
  41 > make gettext
  42
  43