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
Grzegorz Sadowski e745012fa3
minor #10711 [Docs] update docs. (AdamKasp) 
This PR was merged into the 1.7-dev branch.

Discussion
----------

| Q               | A
| --------------- | -----
| Branch?         | master 
| Bug fix?        | no
New feature?    | no
| BC breaks?      | no
| Deprecations?   | no
| License         | MIT

<!--
 - Bug fixes must be submitted against the 1.4 or 1.5 branch (the lowest possible)
 - Features and deprecations must be submitted against the master branch
 - Make sure that the correct base branch is set
-->


Commits
-------

8425c2d0c4 update docs
2019-10-02 08:28:56 +02:00
..
_exts [Documentation] Initial commit 2016-03-21 17:57:19 +01:00
_images Merge branch '1.4' into 1.5 2019-08-30 14:53:43 +02:00
_themes/sylius_rtd_theme Update online course ad 2019-09-02 13:45:15 +02:00
api On the fly fix for product variants api doc 2019-05-03 16:20:23 +02:00
bdd [Docs] Refresh the BDD guide 2019-03-12 12:43:23 +01:00
book minor #10711 [Docs] update docs. (AdamKasp) 2019-10-02 08:28:56 +02:00
components_and_bundles Merge branch '1.4' into 1.5 2019-06-27 09:03:23 +02:00
contributing [Documentation][Contribution] Improve doc contribution guide 2019-08-20 13:40:05 +02:00
cookbook Twig admin show product fixes 2019-08-26 09:02:24 +02:00
customization Merge branch '1.5' into 1.6 2019-08-29 12:02:51 +02:00
getting-started-with-sylius [Docs] Move Plugins section to the Book 2019-07-18 07:55:32 +02:00
plugin-development-guide [Docs] Move Plugins section to the Book 2019-07-18 07:55:32 +02:00
support [Documentation] Document Forum in the support section 2018-06-15 12:03:58 +02:00
.gitignore [Documentation] Initial commit 2016-03-21 17:57:19 +01:00
build.sh Fix docs build 2018-09-18 11:06:58 +02:00
conf.py It's 2019 2019-01-07 14:49:05 +01:00
Dockerfile Fix docs build 2018-09-18 11:06:58 +02:00
index.rst [Docs] Move Plugins section to the Book 2019-07-18 07:55:32 +02:00
README.md Replace sylius.org with sylius.com & fix even more logos 2018-02-08 15:47:41 +01:00
requirements.txt Fix docs build 2018-09-18 11:06:58 +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.