[librecat-dev] Librecat API documentation

[Patrick Hochstenbach]

Great!

I'll check it out further monday how we want to integrate this into the LibreCat wiki!

Patrick
________________________________________
From: librecat-dev-bounces at lists.uni-bielefeld.de <librecat-dev-bounces at lists.uni-bielefeld.de> on behalf of Jakob Voß <Jakob.Voss at gbv.de>
Sent: Friday, February 3, 2017 2:43 PM
To: librecat-dev
Subject: [librecat-dev] Librecat API documentation

Hi,

I have finished a Perl module to convert POD to anything supported by
pandoc document converter:

https://github.com/nichtich/Pod-Pandoc

As example, the documentation of Pod::Pandoc is pushed to a GitHub wiki
and to Read The Docs with each commit at the master branch:

https://github.com/nichtich/Pod-Pandoc/wiki
http://pod-pandoc.readthedocs.io/en/latest/Pod-Pandoc.html


Using pod2pandoc I created Librecat API documentation in HTML and put it
into the gh-pages branch:

http://librecat.org/LibreCat/

There is no HTML template and CSS yet but this is supported by pandoc:

http://pandoc.org/MANUAL.html#templates

Before investing more time in this I'd like to know some more
requirements (possibly as GitHub issue).

Cheers
Jakob

P.S.: Read The Docs also creates a PDF but this might better be done
directly via pandoc:

http://readthedocs.org/projects/pod-pandoc/downloads/pdf/latest/

P.S: Same can be used for updating Catmandu documentation and intermix
it with the existing content from Catmandu wiki.

--
Jakob Voß <jakob.voss at gbv.de>
Verbundzentrale des GBV (VZG) / Common Library Network
Platz der Goettinger Sieben 1, 37073 Göttingen, Germany
+49 (0)551 39-10242, http://www.gbv.de/
_______________________________________________
librecat-dev mailing list
- send list mails to librecat-dev at lists.uni-bielefeld.de
- to unsubscribe or change options, visit https://lists.uni-bielefeld.de/mailman2/cgi/unibi/listinfo/librecat-dev
- project website: http://librecat.org/