README.rst

OXID eShop developer documentation

This is OXID eShop developer documentation. It should provide necessary up to date information for developers.

Currently this repository contains skeleton for documentation which should become useful documentation for developers.

Generated documentation can be found here: http://oxid-eshop-developer-documentation.readthedocs.io/en/latest/

Generating docs locally

Section describes how to generate documentation locally.

1. First of all you'll need to install sphinx.

2. Install PHP highlighting extensions: https://github.com/fabpot/sphinx-php

3. Clone documentation repository:

   git clone https://github.com/OXID-eSales/developer_documentation.git

4. To generate documentation run:

   cd developer_documentation
   sphinx-build ./ ./build

5. Open build/index.html file with your browser.

Generating diagrams

To generate diagrams using plantUml, use this command:

java -jar /opt/plantuml.jar -svg -o ./ **.puml

/opt/plantuml.jar - path to your plantUml file.

PlantUml will generate .svg files, which can be used in documentation.

Contribution

Rules for writing documentation

Conventions for writing documentation can be found here.