Sylius/docs
2016-05-10 09:53:14 +02:00
..
_exts [Documentation] Initial commit 2016-03-21 17:57:19 +01:00
_images [Documentation] Initial commit 2016-03-21 17:57:19 +01:00
_themes/sylius_rtd_theme [Documentation] Initial commit 2016-03-21 17:57:19 +01:00
api Merge pull request #4941 from coudenysj/remove-admin-role 2016-05-04 23:35:37 +02:00
behat [Documentation] Initial commit 2016-03-21 17:57:19 +01:00
book [Docs] Remove outdated information about staging environment 2016-05-04 15:49:30 +02:00
bundles [Docs] Theme configuration source "test" 2016-05-10 09:53:14 +02:00
components [Docs] Fix rendering docs on Sphinx ^1.3 🐐 2016-04-29 16:35:24 +02:00
contributing [Docs] Resolve missing references 🐃 2016-04-29 16:35:23 +02:00
cookbook [Docs] Resolve missing references 🐃 2016-04-29 16:35:23 +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] Initial commit 2016-03-21 17:57:19 +01:00
README.md [Docs] Update build instructions 2016-05-06 13:34:30 +02:00
requirements.txt [Docs] Add requirements.txt file for ReadTheDocs 2016-05-06 12:40:08 +02:00

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

If you contribute to documentation you will want to check how it looks after your changes.
To be able to build the documentation, install Sphinx.

  1. Install pip, Python package manager
  2. Download documentation requirements: $ pip install -r requirements.txt
  3. Build the documentation:$ sphinx-build -b html . build

Documentation index is build/index.html.

Authors

See the list of our amazing contributors.