blob: ab69683a862db8eeefc606df4277380576f617f2 [file] [log] [blame]
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
.. Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
It is assumed knowledge that your able to *clone/fork* the **Git** repository containing the project. This repository can be
found publicly at .
The project also uses the pull request development workflow. At tutorial of this workflow can be found here .
.. topic:: Requirements
* Python 2.7+
* Pip
* make
Installing Sphinx
Sphinx is a easy to use documentation system which is most notably used for the python documentation. It was chosen
by the project to be used due to its ease of use and available outputs (Html & Pdf). This allows print out
publications to be made and a large availability for online and offline use.
Sphinx is recommended to be installed through pip:
.. code-block:: python
pip install sphinx
**Latex Pdf additional Packages**
These packages may be required when building the pdf version of the documents.
Debian Based:
.. code-block:: python
apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended