[Koha] Koha Documentation

Chris Cormack chrisc at catalyst.net.nz
Mon Nov 21 09:58:26 NZDT 2016


Hi All

As most of you will know I have been converting the Kohadocs to use
Sphinx instead of Docbook XML.

This is all ready to go. Both the master branch and the manual16.11.x 
branches are using Sphinx.

You can see them here
http://git.koha-community.org/gitweb/?p=kohadocs.git;a=shortlog;h=refs/heads/manual16.11.x
and
http://git.koha-community.org/gitweb/?p=kohadocs.git;a=shortlog;h=refs/heads/master

Sphinx uses restructured text (like markdown) which is easier to read
and edit. The file is broken up into smaller sections under en/source

You will see a list of files like 01_intro.rst
02_administration.rst
etc

You can open these in any text editor you like, the format is quite
simple to understand, but if you want to do something fancy you can read
the primer here http://www.sphinx-doc.org/en/1.4.8/rest.html#rst-primer

So you can submit patches the way people have always done.
Or
If you want, you can go to 
https://gitlab.com/koha-community-devs-users/kohadocs

And submit merge requests.

You can even edit the files in your webbrowser, eg
https://gitlab.com/koha-community-devs-users/kohadocs/blob/master/en/source/01_intro.rst

And select edit (if you are logged in). You can use the preview link to
see what it will look like before you submit your changes.

Happy documenting everyone

Chris
-- 
Chris Cormack
Catalyst IT Ltd.
+64 4 803 2238
PO Box 11-053, Manners St, Wellington 6142, New Zealand
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <https://lists.katipo.co.nz/pipermail/koha/attachments/20161121/5347eadd/attachment.sig>


More information about the Koha mailing list