README.md 648 Bytes
Newer Older
XivoBuilder's avatar
XivoBuilder committed
1 2 3
Xivo-solutions-doc
==================

4
This is the documentation project of the XiVO Solutions. It is available at http://xivosolutions.readthedocs.io/.
XivoBuilder's avatar
XivoBuilder committed
5 6 7 8 9

Dependencies
------------

* Sphinx (package python-sphinx on Debian)
10 11
* sphinx-git modified (for git changelog). To install it:

12
  pushd /tmp && sudo pip install git+https://gitlab.com/xivo.solutions/sphinx-git.git@tagtitles && popd
XivoBuilder's avatar
XivoBuilder committed
13 14 15 16 17 18

Build
-----

   make clean html

19 20 21 22 23 24 25 26 27 28 29

PDF version
-----------

You will need a LATEX compilation suite. On Debian, you can use the following
packages :

$ apt-get install texlive-latex-base texlive-latex-recommended
texlive-latex-extra texlive-fonts-recommended