/documentation

The OroPlatform and OroCRM documentation.

Primary LanguageCSSOtherNOASSERTION

Oro Documentation

Oro documentation explains how to develop business application in easy and extendable way. The use of the documentation is subject to the CC-BY-NC-SA 4.0 license.

Documentation is published at https://www.oroinc.com/doc/orocrm

Documentation Structure

Overview of Platform architecture, design and key features. This section will help to understand better platform design and technical details.

Developer guidance to specific features and implementations, collection of "How to" articles that allow to achieve result in quick and right way without going deep into technical details.

End user oriented documentation that explains how to administer and configure platform features.

Learn about our development process and how you can contribute to the Oro Platform.

Build Documentation in Local Environment

In Oro solutions, documentation uses reStructuredText format and could be built with Sphinx:

  1. Install pip.
  2. Install Sphinx with Extensions for PHP and Symfony using the following command:   pip install --upgrade -q -r requirements.txt
  3. Run make html in documentation folder. Ensure that conf.py (documentation build configuration file) is there.

Documentation will be available in _build/html folder.