From: Katrin Fischer <katrin.fischer.83@web.de>
Date: Thu, 6 Dec 2018 09:22:23 +0000 (+0100)
Subject: Restore Read me with the instructions on how to use Sphinx locally
X-Git-Tag: 19.05.00~31^2
X-Git-Url: http://git.equinoxoli.org/?p=kohadocs.git;a=commitdiff_plain;h=02849c9424acc311064af1a7a1f9829ae1c7894d

Restore Read me with the instructions on how to use Sphinx locally

These instructions have been lost when the manual repository
was moved. Just restoring the hints for now.
---

diff --git a/README.md b/README.md
index 3c86d77..581559d 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,61 @@
 Koha Documentation
 ==================
 
-This is the main repository for the Koha manual
-It is mirrored at git.koha-community.org also
\ No newline at end of file
+This is the main repository for the Koha manual.
+It is mirrored at git.koha-community.org.
+
+The manual is generated with Sphinx.
+
+Setup
+-----
+
+> sudo apt-get install python3-sphinx  python3-sphinxcontrib.spelling
+
+Outputing Docs
+--------------
+
+### For HTML
+> make html
+
+### For HTML in a single page
+>  make singlehtml
+
+### For an epub
+>  make epub
+
+### For a pdf (Work in progress)
+
+Install latexmk, the latexpdf builder needs it
+
+> apt install latexmk 
+
+Install texlive-full. Attention: this is very huge
+
+> apt install texlive-full 
+
+Generate the latex files
+
+> make latex 
+
+Generate the PDF file
+
+> make latexpdf
+
+
+Other useful commands
+---------------------
+
+To find everything that you can do, you can just do
+
+> make
+
+And it will list all the available options. Some useful ones are
+
+### Check spelling
+> make spelling
+
+### Check links in the documentation
+> make linkcheck
+
+### Generate .po files for translation
+> make gettext