ciaa / doc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Readme

This is the Root directory of the CIAA Documentation Project. This project contains the Documentation of the CIAA Project. During the development of new modules and not completed documentation may be found in the CIAA Project WebPage: http://www.proyecto-ciaa.com.ar. Once the documentation becomes stable is added to this documentation repo.

Download generated Documentation

If you do not want to generate the documentation yourself, you may want to try our Jenkins output. For each commit on this repo the HTML and PDFs are generated automatically and can be downloaded from: http://ciaa1.uns.edu.ar/jenkins/job/Documentation/

Dependencies to build the documentation

This documentation is based on DocBook you will need the following packages in Linux to generate pdfs and htmls documentation:

sudo apt-get install libxml2-utils
sudo apt-get install xsltproc
sudo apt-get install fop

NOTE: DocBook package itself is not needed, since is part of this repo.

How to build this documentation

Once you have the needed dependencies you can run the command:

make

to build all documents. You may also use the command make help to more details.

About


Languages

Language:XSLT 79.8%Language:HTML 11.9%Language:JavaScript 6.8%Language:CSS 0.6%Language:Shell 0.3%Language:Makefile 0.1%Language:Ruby 0.1%Language:Python 0.1%Language:SystemVerilog 0.1%Language:Erlang 0.0%Language:NewLisp 0.0%Language:Perl 6 0.0%Language:Perl 0.0%Language:ApacheConf 0.0%