You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
10 hours ago | |
---|---|---|
icons | 13 years ago | |
locales | 5 years ago | |
public | 5 years ago | |
source | 10 hours ago | |
.gitignore | 3 years ago | |
.gitlab-ci.yml | 4 months ago | |
CONTRIBUTING.md | 5 years ago | |
LICENSE | 6 years ago | |
Makefile | 3 years ago | |
README.md | 3 years ago | |
mappings.pl | 6 years ago |
README.md
Koha Documentation
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 make python3-sphinx python3-sphinxcontrib.spelling python3-pip
sudo pip3 install sphinx_rtd_theme
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