This directory contains documentation for Sylius - Open Source eCommerce platform on top of Symfony, available on docs.sylius.com.
It is hosted by the great readthedocs.org.
If you want to keep up with all the updates, follow the official Sylius account on twitter.
The documentation uses GitHub issues.
To test the documentation before a commit:
-
Download the documentation requirements:
pip install -r requirements.txtThis makes sure that the version of Sphinx you'll get is >=1.4.2!
-
Install Sphinx
pip install Sphinx -
In the
docsdirectory runsphinx-build -b html . buildand view the generated HTML files in thebuilddirectory.
See the list of our amazing contributors.