OXID eShop Developer Documentation
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_static
_templates
_themes/sphinx_rtd_theme
getting_started
media/icons-en
modules
oxid_components
project
system_architecture
themes
update
.gitignore
.travis.yml
LICENSE OXDEV-613 Add migration guideline for WysiwygPro Dec 14, 2017
README.rst
conf.py
conventions.rst
glossary.rst
index.rst

README.rst

OXID eShop developer documentation

https://travis-ci.org/OXID-eSales/developer_documentation.svg?branch=master

This is the OXID eShop developer documentation.

The generated documentation can be found here: https://docs.oxid-esales.com/developer/en/6.0/

If you want to contribute, please read https://docs.oxid-esales.com/developer/en/6.0/index.html#help-improving-this-documentation. Generate the documentation locally in order to test your changes as described in the following section.

Generating docs locally

Section describes how to generate documentation locally.

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

  2. Install the PHP highlighting extensions

  3. Install the plantuml extension. Either configure the path to the file plantuml.jar in the file config.py or put a wrapper script in your path like described in the link above.

  4. Clone documentation repository:
    git clone https://github.com/OXID-eSales/developer_documentation.git
  5. To generate documentation run:
    cd developer_documentation
    sphinx-build ./ ./build
  6. 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.