Koha-community
/
koha-manual
mirror of https://gitlab.com/koha-community/koha-manual.git
1
0
Fork 0
Code Issues Releases Wiki Activity
Koha Documentation repository
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.
3388 Commits
29 Branches
14 Tags
231 MiB
 
 
Branch: master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
Caroline Cyr La Rose 8de8066990
Added a bit about multiple regex splitting rules and splitting after X characters 		3 months ago
icons added css and icons for css 12 years ago
locales Update/add locales files 3 years ago
public Getting rid of the en/ dir, a relic from the docxml days 4 years ago
source Added a bit about multiple regex splitting rules and splitting after X characters 3 months ago
.gitignore Teach git to ignore build directory. 1 year ago
.gitlab-ci.yml updated gitlab-ci.yml to change the version number 6 months ago
CONTRIBUTING.md Fix #10 - update url to the new repository 3 years ago
LICENSE Add license 5 years ago
Makefile Add the quiet switch to SPHINXOPTS 2 years ago
README.md Update setup instructions for Sphinx RTD theme. 1 year ago
mappings.pl Add a script to ease the move - mappings.pl 4 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