Sylius/docs
2020-05-13 12:13:07 +02:00
..
_exts [Docs] Allow redirecting to URLs 2020-05-11 16:16:24 +02:00
_images [Docs][Book] Fix payment state machine diagram 2020-05-13 12:13:07 +02:00
_themes/sylius_rtd_theme feature #11054 [Documentation] Sylius Plus features documentation v1 (CoderMaggie) 2020-01-24 15:09:01 +01:00
api [Docs] Redirect Grid & GridBundle docs to external URL 2020-05-11 16:29:18 +02:00
bdd [missing return] Update basic-usage 2020-03-03 10:41:38 +01:00
book [Docs][Book] Fix payment state machine diagram 2020-05-13 12:13:07 +02:00
components_and_bundles [Docs] Redirect Registry docs to external URL 2020-05-11 16:36:32 +02:00
contributing [Docs] Improved coping UX 2020-03-06 09:46:59 +01:00
cookbook refactor #11454 [Docs] Extract technical packages documentation to an external URLs (pamil) 2020-05-12 10:39:17 +02:00
customization [Docs] Redirect Grid & GridBundle docs to external URL 2020-05-11 16:29:18 +02:00
getting-started-with-sylius [Docs] Improved coping UX 2020-03-06 09:46:59 +01:00
plugin-development-guide [Docs] Remove Kernel.php changes in naming changes 2020-05-12 21:42:43 +02:00
support [Documentation] Document Forum in the support section 2018-06-15 12:03:58 +02:00
theming [Docs] Improved coping UX 2020-03-06 09:46:59 +01:00
.gitignore Update sensio.sphinx 2020-01-20 13:07:36 +01:00
build.sh Fix docs build 2018-09-18 11:06:58 +02:00
conf.py Merge branch '1.6' into 1.7 2020-03-02 12:05:49 +01:00
Dockerfile Update sensio.sphinx 2020-01-20 13:07:36 +01:00
index.rst [Docs] Theming Guide: Webpack Encore v1 2019-11-08 10:57:15 +01:00
README.md [Docs] Improved coping UX 2020-03-06 09:46:59 +01:00
redirection_map [Docs] Redirect Registry docs to external URL 2020-05-11 16:36:32 +02:00
requirements.txt Update sensio.sphinx 2020-01-20 13:07:36 +01:00

Sylius Documentation

This directory contains documentation for Sylius - Decoupled eCommerce Platform, available on docs.sylius.com.

It is hosted by the great readthedocs.org.

Sylius on Twitter

If you want to keep up with all the updates, follow the official Sylius account on twitter.

Issues

The documentation uses GitHub issues.

Build

To test the documentation before a commit:

  • Install pip, Python package manager

  • Download the documentation requirements:

    pip install -r requirements.txt

    This makes sure that the version of Sphinx you'll get is >=1.4.2!

  • Install Sphinx

    pip install Sphinx

  • In the docs directory run sphinx-build -b html . build and view the generated HTML files in the build directory.

Authors

See the list of our amazing contributors.