kenaug74/Sylius
1
0
Fork 0
mirror of https://github.com/Sylius/Sylius.git synced 2026-07-14 17:10:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
Sylius/docs
History
tuka217 67515a25c9 [Core] Rename ShippingMethodsByZoneAndChannelResolver to ZonesAndChannelBasedShippingMethodsResolver 
[Shipping] Rename MethodsResolver to ShippingMethodsResolver (same with interface)
[Payment] Rename MethodsResolver to PaymentMethodsResolver (same with interface)
2016-08-04 10:51:45 +02:00
..
_exts [Documentation] Initial commit 2016-03-21 17:57:19 +01:00
_images [Documentation] Currencies 2016-07-26 15:43:57 +02:00
_themes/sylius_rtd_theme [Documentation] Initial commit 2016-03-21 17:57:19 +01:00
api [DOC] Update api doc 2016-07-28 18:22:09 +02:00
behat Fix typo in 'introduction to containers and scopes' page 2016-08-02 10:47:22 +02:00
book [Documentation] Products 2016-07-27 15:03:56 +02:00
bundles [Core] Rename ShippingMethodsByZoneAndChannelResolver to ZonesAndChannelBasedShippingMethodsResolver 2016-08-04 10:51:45 +02:00
components [Core] Rename ShippingMethodsByZoneAndChannelResolver to ZonesAndChannelBasedShippingMethodsResolver 2016-08-04 10:51:45 +02:00
contributing Fix typo in the overview of the contributing page for the documentation 2016-08-02 10:48:30 +02:00
cookbook [Documentation] Customization Guide - Controllers 2016-06-16 15:16:05 +02:00
customization [Documentation] Customizing models fix 2016-07-07 11:14:47 +02:00
.gitignore [Documentation] Initial commit 2016-03-21 17:57:19 +01:00
conf.py [Docs] Fix rendering docs on Sphinx ^1.3 🐐 2016-04-29 16:35:24 +02:00
index.rst [Documentation] Resource Layer and State Machine update 2016-07-14 14:31:57 +02:00
README.md [Docs] README update 2016-06-08 16:20:51 +02:00
requirements.txt [Docs] Add requirements.txt file for ReadTheDocs 2016-05-06 12:40:08 +02:00

README.md

Sylius Documentation

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

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.