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
Teoh Han Hui df840ef990
Upgrade to gulp 4 
Use gulpfile.babel.js so that we can write in ES2015+
2018-05-18 15:56:51 +02:00
..
_exts [Documentation] Initial commit 2016-03-21 17:57:19 +01:00
_images Review fixes 2017-10-16 14:43:07 +02:00
_themes/sylius_rtd_theme [Documentation] Initial commit 2016-03-21 17:57:19 +01:00
api Merge branch '1.0' into 1.1 2018-03-19 08:48:53 +01:00
bdd Review fixes 2017-09-08 10:56:26 +02:00
book Upgrade to gulp 4 2018-05-18 15:56:51 +02:00
components_and_bundles Use %kernel.project_dir% instead of %kernel.root_dir% 2018-05-01 15:49:07 +02:00
contributing Upgrade to gulp 4 2018-05-18 15:56:51 +02:00
cookbook Upgrade to gulp 4 2018-05-18 15:56:51 +02:00
customization Fix product repository's service id in docs 2018-04-14 23:18:26 +02:00
plugins Replace sylius.org with sylius.com & fix even more logos 2018-02-08 15:47:41 +01:00
support Replace sylius.org with sylius.com & fix even more logos 2018-02-08 15:47:41 +01:00
.gitignore [Documentation] Initial commit 2016-03-21 17:57:19 +01:00
conf.py [Maintenance] Bump year in docs and license file 2017-01-26 11:58:45 +01:00
CONTRIBUTING.md Replace sylius.org with sylius.com & fix even more logos 2018-02-08 15:47:41 +01:00
index.rst Replace sylius.org with sylius.com & fix even more logos 2018-02-08 15:47:41 +01:00
ISSUE_TEMPLATE.md Replace sylius.org with sylius.com & fix even more logos 2018-02-08 15:47:41 +01:00
PULL_REQUEST_TEMPLATE.md Update pull request template 2017-12-28 08:53:43 +01:00
README.md Replace sylius.org with sylius.com & fix even more logos 2018-02-08 15:47:41 +01:00
requirements.txt Fix sphinx problematic version 2017-10-12 09:04:46 +02:00

README.md

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.